summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..687421e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# The Mana World 2 Toolset
+
+This repository holds many tools for TMW2 project.
+
+## Translation Related
+
+Translations can be updated by using `lang/updatelang.py` command. Please note this
+is server-sided, for Client-Data translations, check `lang_client` folder instead.
+
+## Update Related
+
+Server news can be found at `update/news.txt`. The `createnew.sh` and `update.sh`
+scripts will aid when we have to deploy them at remote server.
+
+## Localhost Related
+
+When running a localhost, you'll need to follow the instructions at [localserver/README](localserver/README)
+or it won't work at all.
+
+## Legacy Server Importer
+
+Thanks to the efforts from the Great Sage Of Keyboards, Andrei Akaras, we can
+easily import to this server the data from TMW Legacy. Details can be obtained with
+him. Please check the `hercules` folder for all scripts which carries over the data.
+
+## Non Related
+
+Many folders in this toolset are not relevant for this project, or used by other tools.
+Please refrain from messing things! Thanks!