diff --git a/devtools/README.md b/devtools/README.md index 619bc05..058330c 100644 --- a/devtools/README.md +++ b/devtools/README.md @@ -1,4 +1,3 @@ # Development tools - -__fake_java.py__ can be used to get the command used to start Minecraft. When run, it will create a file called `fake_java_out.txt` in its working directory. -__rmpyc__ removes all `.pyc` files in the current working directory and all subdirectories. +* __fake_java.py__ can be used to get the command used to start Minecraft. When run, it will create a file called `fake_java_out.txt` in its working directory. +* __rmpyc__ removes all `.pyc` files in the current working directory and all subdirectories. diff --git a/lib/launcher/python/README.md b/lib/launcher/python/README.md index 627115a..27514a3 100644 --- a/lib/launcher/python/README.md +++ b/lib/launcher/python/README.md @@ -1,5 +1,43 @@ # lib/launcher/python -__gui.py__ will contain the GUI (Wow! Really?). The GUI will be accessed by `main.py`. -__mchandler.py__ will be the launcher library. This time, it will not be a runnable hybrid library. -__updater.py__ will be used for updating the mod pack and possibly the launcher as well. +* __gui.py__ will contain the GUI (Wow! Really?). The GUI will be accessed by `main.py`. +* __mchandler.py__ will be the launcher library. This time, it will not be a runnable hybrid library. +* __updater.py__ will be used for updating the mod pack and possibly the launcher as well. +* __cfghandler.py__ will deal with config files. +* __yggdrasil.py__ will handle user authentication. + +# TODO list + +* __gui.py__ + * [ ] add a function to open the GUI + * [ ] add functions for reading values from the GUI + * [ ] add functions for writing values to the GUI + * [ ] put the port of the GUI here or in a new file? +* __mchandler.py__ + * [ ] add a launch function using the access token + * [ ] add a function to verify a given access token + * [ ] add functtions to pass configuration data + * [ ] launch command (with escape sequences for non-static values (configuration and user data) + * [ ] RAM amount + * [ ] Game Directory + * [ ] Additional arguments + * [ ] Anything I may have forgotten +* __updater.py__ + * [ ] add a function to determine whether updates are available + * [ ] add a function to download updates + * [ ] add a function to update the launcher + * [ ] add a function to update the mod pack + * [ ] add different types of updates + * [ ] required launcher updates + * [ ] required mod pack updates + * [ ] optional launcher updates + * [ ] optional mod pack updates + * [ ] setup change updates (used to install/uninstall components) + * [ ] add initial mod pack install by applying a setup change update +* __cfghandler.py__ + * [ ] provide read and write functions for config values + * [ ] add a function to set the config file path + * [ ] add functions to load and store the configuration to the file +* __yggdrasil.py__ + * [ ] add a function to verify user credentials and get the access token + * [ ] add a function to verify a given acces token