Initial commit

README.md

@@ -0,0 +1,76 @@
+# Minecraft Legacy Companion
+
+**Minecraft Legacy Companion** (or **MLC** for short) is a website designed to help you with various aspects of legacy **Minecraft** versions.
+
+For now it can only be used to display block/items ID's (and their obtainability) in **Minecraft** Pre-Classic, Classic and Indev, but in the future it will be expanded up to newer versions (with varying level of support) and additional features.
+
+For running go to the section [over here](#running-on-local-web-server).
+
+**NOT AN OFFICIAL MINECRAFT [PRODUCT/SERVICE/EVENT/etc.]. NOT APPROVED BY OR ASSOCIATED WITH MOJANG OR MICROSOFT**
+
+## Screenshot
+
+<img alt="Minecraft Legacy Companion in a nutshell" src="./screenshots/1.png" height="360" />
+
+## Functionality
+
+Following table shows current and planned functionality:
+
+|                  | Pre-Classic | Classic | Indev | Infdev | Alpha | Beta | Final (pre-flattening[^1]) | Final (after-flattening[^2]) |
+| :--------------: | :---------: | :-----: | :---: | :----: | :---: | :--: | :------------------------: | :--------------------------: |
+|  **Block ID's**  |      ✔️      |    ✔️    | ✔️[^3] |   ❌    |   ❌   |  ❌   |             ❌              |              ❌               |
+|  **Item ID's**   |      🚫      |    🚫    | ✔️[^3] |   ❌    |   ❌   |  ❌   |             ❌              |              ❌               |
+|   **Mob ID'S**   |      ❓      |    ❓    |   ❓   |   ❓    |   ❓   |  ❓   |             ❌              |              ❌               |
+| **Achievements** |      🚫      |    🚫    |   🚫   |   🚫    |   🚫   |  ❌   |             ❌              |              ❌               |
+
+## Accessibility
+
+* Website applies high contrast theme when applicable.
+
+## Running on local web server
+
+1. Either:
+   * Download a zip with the repository files by clicking green **Code** button and then clicking **Download ZIP** (simplest);
+
+   * or use `git clone` command (recommended) in your operating system's console (recommended), note that you might need to install [git](https://git-scm.com/) first.
+
+     * After making sure you have git installed you just need to enter following command in your console: `git clone https://github.com/Matriks404/mlc.git`
+
+2. Run a web server on your local machine (or somewhere else) using any server software you like to use with this project's root directory as location.
+
+     * On Windows you can use [PHP built-in web server](https://windows.php.net/download#php-8.3). Select appropriate version and install it. Alternatively use anything else, it should work with any HTTP server.
+
+       * If you use PHP built-in server you can run use following example commands to launch server with the website: `cd /d <php installed location> && php.exe -S 0.0.0.0:8888 -t <project location>`, if you want to make your life easier you can make a batch script that runs these commands.
+
+     * On Unix-like operating systems (e.g. Linux, any BSD or macOS) you can figure it out on your own.
+
+3. Open `localhost:<port>` URL in your browser on local machine.
+
+   * If you followed instructions for getting PHP installed on Windows, website is located at `localhost:8888`.
+
+Website will also of course work for any device that is connected on your local network as long as you configured HTTP server properly and entered valid IP of your computer on other device's web browser (NOT `localhost`). If you use PHP built-in web server on Windows, this should work by default.
+
+## Version importance
+
+Functionality for versions will be added in waves by following priority:
+
+1. **Versions <= Beta 1.7.3** - These are highest priority.
+2. **Versions <= Release 1.7.10** - These are medium-high priority.
+3. **Versions < Flattening (1.13 Snapshot 17w47a)** - These are low priority.
+4. **Versions > Flattening (1.13 Snapshot 17w47a)** - These will probably not be supported at all, given project goal. There are better resources (like [Minecraft Wiki](https://minecraft.wiki)) for these. Contributions are welcome though, as long as they don't break or heavily change existing codebase.
+
+## Licensing terms
+
+All of the original content is licensed under **CC BY-NC-SA 3.0** (compatible with [minecraft.wiki](https://minecraft.wiki/w/Minecraft_Wiki:Copyrights)) license.
+
+The design of the interface is based on the [this diagram](https://minecraft.wiki/w/File:DataValuesBeta.png) and the licensing for it applies.
+
+Additionally this project uses in-game rendered **Minecraft** assets which are copyrighted by **[Mojang Studios](https://mojang.com)**, the terms of use for these assets can be found [here](https://www.minecraft.net/en-us/usage-guidelines#terms-brand_guidelines).
+
+
+
+[^1]: Applies to versions before Minecraft 1.13 snapshot 17w47a.
+
+[^2]: Applies to versions after (and including) Minecraft 1.13 snapshot 17w47a.
+
+[^3]: Minecraft Indev 0.31 versions: 20091231-2, 20100104 and 20100110 have unknown block renders and unknown block ID's.

config.json

@@ -0,0 +1,4 @@
+{
+	"versionNumber": "0.1",
+	"versionType": "dev"
+}