-
Notifications
You must be signed in to change notification settings - Fork 10
rendition: Add API Documentation #16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
RegDogg
wants to merge
13
commits into
ToontownRewritten:master
Choose a base branch
from
RegDogg:master
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
fd3959c
rendition: Add API Documentation
RegDogg 51c945f
rendition: Fix typo
RegDogg 2d2ba37
rendition: Another typo haha
RegDogg 265e1d7
rendition: Slight text change.
RegDogg 9169d14
rendition: DNA string is generated.
RegDogg 46f7af7
rendition: Get your DNA string in-game
RegDogg 80c1d9a
rendition: Added laffmeter as a type for rendering
RegDogg 6dbfecb
rendition: Add Red Nose Toggle, last 3 bytes are Shoes
RegDogg 7f32c3d
render: DNA Byte 17 Is supposedly the version of DNA
RegDogg f056b5f
All poses now available courtesy of Lappy.
RegDogg 7fc2cd5
Update toon-rendition.md
RegDogg fac1ddb
Merge branch 'ToontownRewritten:master' into master
RegDogg 182340f
Merge branch 'ToontownRewritten:master' into master
RegDogg File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Toontown Rewritten Rendition API | ||
|
|
||
| ## Overview | ||
|
|
||
| This API generates a screenshot of a toon based on a DNA string. | ||
|
|
||
| ## Requests | ||
|
|
||
| An HTTP GET to the rendition endpoint, https://rendition.toontownrewritten.com/render/{dna}/{pose}/{width}x{height}.{extension}, will return the generated render. | ||
|
|
||
| ## Parameters | ||
|
|
||
| | Name | Details | | ||
| |-------------|---------| | ||
| | dna | The DNA string for the toon to be rendered. (Use Shift+F11 in-game to copy your toon DNA) | | ||
| | pose | Pose your toon makes. At the moment these are the 8 options. (**head, laffmeter, portrait, portait-sleep, portrait-delighted, portrait-surprise, portrait-thinking, portrait-birthday, portrait-fall, portrait-grin, cake-topper, crying, waving**) | | ||
| | width | Width of the returned render (ex. **1024**). | | ||
| | height | Height of the returned render (ex. **1024**). | | ||
| | extension | File extension can be either **png** or **webp** | | ||
RegDogg marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## Response | ||
|
|
||
| A toon from the provided DNA string will be generated. | ||
|
|
||
| Example: https://rendition.toontownrewritten.com/render/7424010101021d021d8b1b160016160104001c0000040000000000000000000000/portrait-birthday/1024x1024.png | ||
RegDogg marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo:
portait-sleepshould beportrait-sleepThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh and it might be worth mentioning that the DNA string can also be retrieved from the local API.