lesderid
/
fkg-api-proxy
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add license section to readme

This commit is contained in:
Les De Ridder 2017-08-13 00:01:03 +02:00
parent 3b57471d3d
commit 4994fdc1b4
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -13,9 +13,9 @@ This is a proxy for DMM's version of Flower Knight Girl. Currently its main feat
## Translations
To use the proxy for translations based on the Nutaku version, you need to generate the data from the Nutaku version's master data. You can do this by following these steps:
To use the proxy for translations based on the Nutaku version, you need to generate the data from the Nutaku version's master data:
0. Install [fish](https://fishshell.com/) and [csvquote](https://github.com/dbro/csvquote)
1. Save the /master/getMaster API response of the Nutaku version
1. Save the `/master/getMaster` API response of the Nutaku version
2. Decompress the response (zlib) and name the file 'nutakuMaster.json'
3. Run `./generate-translations.fish`
4. Verify the translations were generated correctly by looking at the output of `head data/*`
@ -33,3 +33,7 @@ To use the proxy for translations based on the Nutaku version, you need to gener
## Disclaimer
This is most likely against DMM's ToS. Use at your own risk. That said, it should be unlikely that you'd get banned for using this, since it shouldn't be detectable from DMM's side.
## License
This project is released under the [University of Illinois/NCSA Open Source License](LICENSE).