Updated readme and added more READMEs
parent
6e9afc42a6
commit
5d2870506b
23
README.md
23
README.md
|
@ -1,10 +1,10 @@
|
||||||
# CustomMinecraftLauncher
|
# CustomMinecraftLauncher
|
||||||
The Launcher for my mod pack
|
The Launcher for my mod pack
|
||||||
|
|
||||||
# TODO List
|
# General TODO List
|
||||||
* [ ] Frontend
|
* [ ] Frontend
|
||||||
* [ ] Port the GUI (and fix the design differences between Desktop environments) or write a new one
|
* [ ] Port the GUI (and fix the design differences between Desktop environments) or write a new one
|
||||||
* [ ] Write a command line interface / hybrid library to handle the other libraries and the GUI
|
* [ ] Write a CLI / GUI hybrid program to handle the libraries
|
||||||
* [ ] Library development
|
* [ ] Library development
|
||||||
* [ ] Write a new Game launching Library
|
* [ ] Write a new Game launching Library
|
||||||
* [ ] Create server startup request library
|
* [ ] Create server startup request library
|
||||||
|
@ -17,3 +17,22 @@ The Launcher for my mod pack
|
||||||
* [ ] News page
|
* [ ] News page
|
||||||
* [ ] Credits page
|
* [ ] Credits page
|
||||||
* [ ] Create the launcher backend
|
* [ ] Create the launcher backend
|
||||||
|
|
||||||
|
# Documentation
|
||||||
|
## Directories
|
||||||
|
* __devtools__ contains development tools
|
||||||
|
* __lib__ contains libraries for Minecraft and the launcher
|
||||||
|
* __res__ contains the resources/assets used by Minecraft
|
||||||
|
* __run__ contains the running directory / game directory
|
||||||
|
## Files
|
||||||
|
* __main.py__ the main file of the Launcher
|
||||||
|
|
||||||
|
# TODO list
|
||||||
|
* __main.py__
|
||||||
|
* [ ] run the updater
|
||||||
|
* [ ] CLI
|
||||||
|
* [ ] GUI
|
||||||
|
* [ ] decide whether to launch the GUI
|
||||||
|
* [ ] launch GUI (from `gui.py`)
|
||||||
|
* [ ] get user input from GUI
|
||||||
|
* [ ] Act according to the user input
|
||||||
|
|
|
@ -0,0 +1,2 @@
|
||||||
|
# res
|
||||||
|
This directory will contain the resources used by Minecraft.
|
Reference in New Issue