Skip to content

I respect your options. Lets you copy a set of default options into the config folder on the first launch of the game.

License

Notifications You must be signed in to change notification settings

KdGaming0/iRespectYourOptions

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

## I Respect Your Options

### This mod has one simple function, to allow a modpack creator to deliver a set of default options that will be copied over to the config folder upon the game's first launch.

How will it work in practice?

Let's see a few examples.

- Example 1 (options.txt or files/folders you want to put in the root directory of Minecraft.)
Create /config/iRespectYourOptions/options.txt Put default content in it Launch the game! iRespectYourOptions will copy /config/iRespectYourOptions/options.txt into /options.txt. So all the files there will be copied to the root directory of your game. (And yes it works with the optionsof.txt the option file for optifine.)

- Example 2 (config/testmod/testmodconfig.json5)
Create /config/iRespectYourOptions/config/testmod/testmodconfig.json5 Put default content in it Launch the game! YOSBR will copy /config/iRespectYourOptions/config/testmod/testmodconfig.json5 into /config/testmod/testmodconfig.json5. So all the files there will be copied to the config directory.

### Important
- When the game has launched for the first time an iRespectYourOptions.cfg file will be created in the config folder and as long that file exists it will not try to copy the files. If you want to overwrite the configs back to the default one just delete it and restart the game.
- Modpack developers should not include the iRespectYourOptions.cfg file in their distribution to users since it defeats the purpose of the mod.

-----------------------------------------------------------------------------------------------

Inspired by the [Your Options Shall Be Respected (YOSBR)](https://modrinth.com/mod/yosbr) mod. If you need the mod for newer version go and find that one.


-------------------------------------------
Source installation information for modders
-------------------------------------------
This code follows the Minecraft Forge installation methodology. It will apply
some small patches to the vanilla MCP source code, giving you and it access 
to some of the data and functions you need to build a successful mod.

Note also that the patches are built against "unrenamed" MCP source code (aka
srgnames) - this means that you will not be able to read them directly against
normal code.

Source pack installation information:

Standalone source installation
==============================

Step 1: Open your command-line and browse to the folder where you extracted the zip file.

Step 2: Once you have a command window up in the folder that the downloaded material was placed, type:

Windows: "gradlew setupDecompWorkspace"
Linux/Mac OS: "./gradlew setupDecompWorkspace"

Step 3: After all that finished, you're left with a choice.
For eclipse, run "gradlew eclipse" (./gradlew eclipse if you are on Mac/Linux)

If you preffer to use IntelliJ, steps are a little different.
1. Open IDEA, and import project.
2. Select your build.gradle file and have it import.
3. Once it's finished you must close IntelliJ and run the following command:

"gradlew genIntellijRuns" (./gradlew genIntellijRuns if you are on Mac/Linux)

Step 4: The final step is to open Eclipse and switch your workspace to /eclipse/ (if you use IDEA, it should automatically start on your project)

If at any point you are missing libraries in your IDE, or you've run into problems you can run "gradlew --refresh-dependencies" to refresh the local cache. "gradlew clean" to reset everything {this does not effect your code} and then start the processs again.

Should it still not work, 
Refer to #ForgeGradle on EsperNet for more information about the gradle environment.

Tip:
If you do not care about seeing Minecraft's source code you can replace "setupDecompWorkspace" with one of the following:
"setupDevWorkspace": Will patch, deobfusicated, and gather required assets to run minecraft, but will not generated human readable source code.
"setupCIWorkspace": Same as Dev but will not download any assets. This is useful in build servers as it is the fastest because it does the least work.

Tip:
When using Decomp workspace, the Minecraft source code is NOT added to your workspace in a editable way. Minecraft is treated like a normal Library. Sources are there for documentation and research purposes and usually can be accessed under the 'referenced libraries' section of your IDE.

Forge source installation
=========================
MinecraftForge ships with this code and installs it as part of the forge
installation process, no further action is required on your part.

LexManos' Install Video
=======================
https://www.youtube.com/watch?v=8VEdtQLuLO0&feature=youtu.be

For more details update more often refer to the Forge Forums:
http://www.minecraftforge.net/forum/index.php/topic,14048.0.html

About

I respect your options. Lets you copy a set of default options into the config folder on the first launch of the game.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages