diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 43b8ec529..000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,4 +0,0 @@ - - - - diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..c679cb8f8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,26 @@ +--- +name: Bug report +about: Visit the forum first for issues with crashes. +title: '' +labels: Bug +assignees: '' + +--- + + + + + + +**Minecraft Version:** {Minecraft version} + +**Forge Version:** {Forge version. *Version number, not latest/rb*} + +**Full Log:** {Link to GitHub Gist with full latest.log} + +**Steps to Reproduce:** + 1. Do this + 2. Then do that + 3. ... + +**Description of bug:** diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..3fb3fd7e7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,13 @@ +--- +name: Feature request +about: Want to request a feature? +title: '' +labels: Feature +assignees: '' + +--- + + + + + diff --git a/README.md b/README.md deleted file mode 100644 index 40895a403..000000000 --- a/README.md +++ /dev/null @@ -1,37 +0,0 @@ -# How to install Forge: For Players - -Go to [the Forge website](http://files.minecraftforge.net) - and select the minecraft version you wish to get forge for from the list. - -You can download the installer for the *Recommended Build* or the - *Latest build* there. Latest builds may have newer features but may be - more unstable as a result. The installer will attempt to install forge - into your vanilla launcher environment, where you can then create a new - profile using that version and play the game! - -For support and questions, visit [the Support Forum](http://www.minecraftforge.net/forum/forum/18-support-bug-reports/). - -Here is a short video from Rorax showing how to install and setup Forge: - -[![HOWTO Install Forge](https://img.youtube.com/vi/lB3ArN_-3Oc/0.jpg)](https://www.youtube.com/watch?v=lB3ArN_-3Oc) - -# How to install Forge: For Modders - -[See the "Getting Started" section in the Forge Documentation](http://mcforge.readthedocs.io/en/latest/gettingstarted/). - -# How to install Forge: For those wishing to work on Forge itself - -If you wish to actually inspect Forge, submit PRs or otherwise work - with Forge itself, you're in the right place! - - [See the guide to setting up a Forge workspace](http://mcforge.readthedocs.io/en/latest/forgedev/). - -## Pull requests - -[See the "Making Changes and Pull Requests" section in the Forge documentation](http://mcforge.readthedocs.io/en/latest/forgedev/#making-changes-and-pull-requests). - -### Contributor License Agreement -We require all contributors to acknowledge the [Forge Contributor - License Agreement](https://cla-assistant.io/MinecraftForge/MinecraftForge). Please ensure you have a valid email address - associated with your github account to do this. If you have previously - signed it, you should be OK. diff --git a/CONTRIBUTING.md b/docs/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to docs/CONTRIBUTING.md diff --git a/EnergySystems.md b/docs/EnergySystems.md similarity index 100% rename from EnergySystems.md rename to docs/EnergySystems.md diff --git a/NewFML.md b/docs/NewFML.md similarity index 100% rename from NewFML.md rename to docs/NewFML.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..cbbd45c09 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,65 @@ + + +MinecraftForge [![Latest Release](https://img.shields.io/maven-metadata/v/https/files.minecraftforge.net/maven/net/minecraftforge/forge/maven-metadata.xml.svg?label=latest)](https://files.minecraftforge.net) [![Discord](https://img.shields.io/discord/313125603924639766.svg?color=%237289da&label=discord&logo=discord&logoColor=%237289da)](https://discord.gg/UvedJ9m) [![Support](https://img.shields.io/badge/patreon-support-orange.svg)](https://www.patreon.com/LexManos) [![Merch](https://img.shields.io/badge/flocker-merch-blueviolet.svg)](https://forgedev.flocker.tv/) +============= + +Forge is a free, open-source modding API all of your favourite mods use! + +| Version | Support | +| ------------- | ------------- | +| 1.14.2 | Active (latest) | +| 1.12.2 | Active (stable) | + +* [Download] +* [Forum] +* [Discord] +* [Documentation] + +#### Notes: +- Introduced in 1.13 was a new FML, information found [here](NewFML.md). + +# Installing Forge + +Go to [the Forge website](https://files.minecraftforge.net) + and select the Minecraft version you wish to get Forge for from the list. + +You can download the installer for the *Recommended Build* or the + *Latest build* there. Latest builds may have newer features but may be + more unstable as a result. The installer will attempt to install Forge + into your vanilla launcher environment, where you can then create a new + profile using that version and play the game! + +For support and questions, visit [the Support Forum](https://www.minecraftforge.net/forum/forum/18-support-bug-reports/). + +[Here is a short video from Rorax showing how to install and setup Forge.](https://www.youtube.com/watch?v=lB3ArN_-3Oc) + +# Creating Mods + +[See the "Getting Started" section in the Forge Documentation](https://mcforge.readthedocs.io/en/latest/gettingstarted/). + +# Contribute to Forge + +If you wish to actually inspect Forge, submit PRs or otherwise work + with Forge itself, you're in the right place! + + [See the guide to setting up a Forge workspace](http://mcforge.readthedocs.io/en/latest/forgedev/). + +### Pull requests + +[See the "Making Changes and Pull Requests" section in the Forge documentation](https://mcforge.readthedocs.io/en/latest/forgedev/#making-changes-and-pull-requests). + +Please read the contributing guidelines found [here](CONTRIBUTING.md) before making a pull request. + +### Contributor License Agreement +We require all contributors to acknowledge the [Forge Contributor + License Agreement](https://cla-assistant.io/MinecraftForge/MinecraftForge). Please ensure you have a valid email address + associated with your GitHub account to do this. If you have previously + signed it, you should be OK. + +#### Donate +*Forge is a large project with many collaborators working on it around the clock. Forge is and will always remain free to use and modify. However, it costs money to run such a large project as this, so please consider [becoming a patron](https://www.patreon.com/LexManos) or buying some [cool merch](https://forgedev.flocker.tv/).* + +[Download]: https://files.minecraftforge.net/ +[Forum]: https://www.minecraftforge.net/forum/ +[Discord]: https://discord.gg/UvedJ9m +[Documentation]: https://mcforge.readthedocs.io diff --git a/SUPPORT.md b/docs/SUPPORT.md similarity index 100% rename from SUPPORT.md rename to docs/SUPPORT.md diff --git a/docs/assets/Forge_logo.svg b/docs/assets/Forge_logo.svg new file mode 100644 index 000000000..5705c25c4 --- /dev/null +++ b/docs/assets/Forge_logo.svg @@ -0,0 +1,12 @@ + + + + + + + + + + + +