diff --git a/README.md b/README.md index 57f8bcc..8640b00 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,12 @@ --- -description: Begin here! +description: Welcome to the documentation! coverY: 0 layout: landing --- -# Welcome to OneConfig! +# OneConfig Documentation -Welcome! - -Welcome to the documentation for OneConfig. OneConfig is a configuration and general-purpose library for Minecraft, made for anyone from developers to end-users. This documentation will serve as a place to discover more about OneConfig, its premise, and how to develop mods that use it. +OneConfig is a configuration and general-purpose library for Minecraft, made for anyone from developers to end-users. This documentation will serve as a place to discover more about OneConfig, its premise, and how to develop mods that use it. Please keep in mind that this documentation is still under construction, feedback is appreciated! @@ -24,7 +22,7 @@ OneConfig is designed to be a multiplatform, easy to use library that provides f We want people to be able to configure their mods in one GUI like a custom client, while allowing for the customizability and versatility of loaders like Forge. It's designed to work with pretty much any mod, and includes [compatibility](config/compatibility/ "mention") features to allow mods that might not use the OneConfig system yet to still be edited and used inside the GUI. -We also hope to provide a well documented, easily understandable general purpose library with many [Broken link](broken-reference "mention") so more developers can come onto the Minecraft modding scene with ease. +We also hope to provide a well documented, easily understandable general purpose library with easy-to-understand documentation so more developers can arrive to the Minecraft modding scene with ease. @@ -40,7 +38,7 @@ Wow, looks good right? Here you can configure all your mods, even ones that don' Welcome! -Here you can find how to create Minecraft mods with OneConfig, create configurations for your mods that automatically save and can be edited from the OneConfig GUI, create commands and your own GUI using [oneuiscreen.md](gui/oneuiscreen.md "mention") and much, much more! +Here you can find how to create Minecraft mods with OneConfig, create configurations for your mods that automatically saved and can be edited from the OneConfig GUI, create commands and your own GUI using [oneuiscreen.md](gui/oneuiscreen.md "mention") and much, much more! If you are brand new to Minecraft modding, then you have come to the right place! Minecraft modding can be very scary at first, especially with the lack of good documentation on the web in some places - especially older versions. Make sure to check out [getting-started-with-modding.md](basics/getting-started-with-modding.md "mention") to get started! diff --git a/basics/getting-started-with-modding.md b/basics/getting-started-with-modding.md index 50a3d62..1cf228a 100644 --- a/basics/getting-started-with-modding.md +++ b/basics/getting-started-with-modding.md @@ -4,19 +4,19 @@ description: Learn about how Minecraft Modding works, Java, and how to make Mine # Getting Started with Modding -## Getting Started: What is modding? +## What is modding? Welcome to Minecraft modding! These next few pages will serve as a basic guide for how to get started with Minecraft modding, how to use IntelliJ, Gradle and some Java basics. Minecraft mods are added to the game most commonly using a **loader**, such as [Fabric](https://fabricmc.net) or [Forge](https://files.minecraftforge.net/). The term 'mod' refers to modification for a game, Minecraft in our case. Minecraft is written in Java, so naturally so are its mods. -**You will need some basic knowledge of coding to do this.** But don't worry! Java is reasonably easy to pick up, being an Object Orientated Programming (OoP) language with a reasonably easy to understand syntax. You might want to watch a YouTube tutorial on Java before you begin to help you out. +**You will need some basic knowledge of coding to do this.** But don't worry! Java is reasonably easy to pick up, being an Object Orientated Programming (OOP) language with a reasonably easy to understand syntax. You might want to watch a YouTube tutorial on Java before you begin to help you out. ## Step 1: Installing IntelliJ IDEA For this tutorial, we are going to use the OneConfig Example Mod [**which can be found here**](https://github.com/Polyfrost/OneConfigExampleMod)**.** We are going to use IntelliJ IDEA as our IDE for our coding, and this is the IDE of choice for many mod developers and Java developers. -Firstly, head to [https://www.jetbrains.com/idea/download/](https://www.jetbrains.com/idea/download/) and download the IDE for your platform, in my case Windows. I recommend the Community Edition for casual developers as it has all the features you need - and its free! Download, and follow the prompts to get it installed. +Firstly, head to [https://www.jetbrains.com/idea/download/](https://www.jetbrains.com/idea/download/) and download the IDE for your platform, in my case Windows. I recommend the Community Edition for casual developers as it has all the features you need, and it's free! Download, and follow the prompts to get it installed. -Once that has downloaded, Open up your File Explorer, and create yourself a directory for all your mods, for example **C:/Users/Bob/Documents/Minecraft Mods/.** +Once that has downloaded, open up your File Explorer, and create yourself a directory for all your mods, for example **C:/Users/Bob/Documents/Minecraft Mods/.** ## Step 2: Creating the Project @@ -24,7 +24,7 @@ Great job! You have installed IntelliJ and are ready to clone the project. Now, ![IntelliJ Welcome screen](<../.gitbook/assets/image (3) (1).png>) -Now, click **Get from VCS** and go to **Repository URL** and check that **Version Control** is set to **Git**. Next, **set the directory to that root folder you made earlier**, and in the **URL** box input [https://github.com/Polyfrost/OneConfigExampleMod](https://github.com/Polyfrost/OneConfigExampleMod). Add the **name of your mod to the end of the end of the directory**, so for this tutorial I'm just going to call it "ExampleMod". It should now look something like this: +Now, click **Get from VCS** and go to **Repository URL** and check that **Version Control** is set to **Git**. Next, **set the directory to that root folder you made earlier**, and in the **URL** box input [https://github.com/Polyfrost/OneConfigExampleMod](https://github.com/Polyfrost/OneConfigExampleMod). Add the **name of your mod to the end of the end of the directory**, so for this tutorial, I'm just going to call it "ExampleMod". It should now look something like this: ![IntelliJ Clone screen](<../.gitbook/assets/image (5) (1).png>)