mirror/rsmv
1
0
Fork 0
mirror of https://github.com/skillbert/rsmv.git synced 2025-12-23 21:47:48 -05:00
Code Issues Packages Projects Releases Wiki Activity

Fix the readme

Browse Source
This commit is contained in:
mejrs
2022-06-28 20:24:13 +02:00
parent 744599e233
commit da292bc925
1 changed files with 6 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
readme.md
View File

@@ -1,11 +1,10 @@
# RuneScape Model Viewer (.js) # RuneScape Model Viewer (.js)
A RuneScape cache downloader, decoder and model viewer implemented in javascript. The tool will download the cache directly from the game servers and decode parts of into usable data and models. A RuneScape cache downloader, decoder and model viewer implemented in TypeScript. The tool will download the cache directly from the game servers and decode parts of into usable data and models.
## Installation ## Installation
A new-ish version of node.js is needed with native build tools installed (the node.js installer will ask about this). A new-ish version of node.js is needed with native build tools installed (the node.js installer will ask about this).
After that run the following commands in your systems console. After that run the following commands in your systems console.
```sh ```sh
#install the dependencies #install the dependencies
npm i npm i
@@ -53,22 +52,21 @@ node dist/cli extract
The are more tools in src/scripts, most are used for testing, they are also in various degrees of completeness. The are more tools in src/scripts, most are used for testing, they are also in various degrees of completeness.
## Jagex copyrights ## Jagex copyrights
Jagex is generally aware of the existence of cache decoding tools like this one and they are extensively used for the runescape wiki. However, in the interest of the games integrity and the future of these tools please do no publicly share leaks or unreleased content found using this tool. Jagex is generally aware of the existence of cache decoding tools like this one and they are extensively used for the runescape wiki. However, in the interest of the games integrity and the future of these tools please do not publicly share leaks or unreleased content found using this tool.
## Todo ## Todo
* Rewrite RT5 anims (again) in order to convert shear anims to multiple bones * Rewrite RT5 anims (again) in order to convert shear anims to multiple bones
* Figure out the rest of RT7 anims * Figure out the rest of RT7 anims
* Particles and billboards (both RT and RT7) * Particles and billboards (both RT and RT7)
* Color animations * Color animations
* DAE exporter? (thres.js one doesn't work out of the box) * DAE exporter? (three.js one doesn't work out of the box)
* properly implement caching, currrently doesn't clear texture/model cache * properly implement caching, currrently doesn't clear texture/model cache
## Credits ## Credits
Modern rewrite by Skillbert Modern rewrite by Skillbert
Based on downloader/3d viewer by Sahima, ui by Manpaint Based on downloader/3d viewer by Sahima, ui by [manpaint](https://github.com/manpaint)
2d map based on code by Mej 2d map based on code by [mejrs](https://github.com/mejrs)
Cache loader based on code by Villerman Cache loader based on code by [villermen](https://github.com/villermen)