Description
Description
TXCore adds INI configuration support to Minecraft mods (More usage will be added soon).
Usage User
Just put it in your mods folder.
Usage Developer
Repository
repositories {
maven {
url "https://raw.githubusercontent.com/Txuritan/maven-repository/master/"
}
}
Usage
dependencies {
compile 'com.github.txuritan:txcore:<VERSION>'
}
Load Order
@Mod(
dependencies = "required-after:txcore"
)
public class Core {
}
Your Config
package com.github.txuritan.txcore;
import com.github.txuritan.txcore.api.config.Configuration;
import com.github.txuritan.txcore.api.config.IIniConfig;
import com.github.txuritan.txcore.ini4j.Ini;
import org.apache.logging.log4j.Logger;
public class Config implements IIniConfig {
private Configuration configuration;
public Config(Configuration configuration) {
this.configuration = configuration;
}
private String section = "txcore";
private String sectionTest = section + ".test";
public Boolean debug;
public Boolean testBoolean;
public Double testDouble;
public Float testFloat;
public Integer testInteger;
public Long testLong;
public String testString;
@Override
public void config(Ini ini) {
debug = configuration.getSetKeyBoolean(ini, section, "debug", false);
if(debug) {
getLogger().info("Preforming CoreIni Check");
testBoolean = configuration.getSetKeyBoolean(ini, sectionTest, "testBoolean", false);
getLogger().info("Default value: false, gotten: " + configuration.getKeyBoolean(ini, sectionTest, "testBoolean"));
testDouble = configuration.getSetKeyDouble(ini, sectionTest, "testDouble", 1.0);
getLogger().info("Default value: 1.0, gotten: " + configuration.getKeyDouble(ini, sectionTest, "testDouble"));
testFloat = configuration.getSetKeyFloat(ini, sectionTest, "testFloat", 1.0f);
getLogger().info("Default value: 1.0f, gotten: " + configuration.getKeyFloat(ini, sectionTest, "testFloat"));
testInteger = configuration.getSetKeyInteger(ini, sectionTest, "testInteger", 1);
getLogger().info("Default value: 1, gotten: " + configuration.getKeyInteger(ini, sectionTest, "testInteger"));
testLong = configuration.getSetKeyLong(ini, sectionTest, "testLong", 1L);
getLogger().info("Default value: 1L, gotten: " + configuration.getKeyLong(ini, sectionTest, "testLong"));
testString = configuration.getSetKeyString(ini, sectionTest, "testString", "yay it works");
getLogger().info("Default value: \"yay it works\", gotten: " + configuration.getKeyString(ini, sectionTest, "testString"));
}
}
@Override
public Logger getLogger() {
return References.LOGGER;
}
@Override
public String configPath() {
return configuration.getSuggestedConfig();
}
@Override
public String modId() {
return References.MOD_ID;
}
}
Register
package com.github.txuritan.txcore.proxy;
import com.github.txuritan.txcore.Config;
import com.github.txuritan.txcore.api.config.Configuration;
import net.minecraftforge.fml.common.event.FMLInitializationEvent;
import net.minecraftforge.fml.common.event.FMLPostInitializationEvent;
import net.minecraftforge.fml.common.event.FMLPreInitializationEvent;
public class CommonProxy {
public void preInit(FMLPreInitializationEvent event) {
Configuration.INSTANCE.registerConfig(new Config(Configuration.INSTANCE));
}
public void init(FMLInitializationEvent event) {
}
public void postInit(FMLPostInitializationEvent event) {
}
}
Output
[txcore.test]
testBoolean = false
testDouble = 1.0
testFloat = 1.0
testInteger = 1
testLong = 1
testString = yay it works
[txcore]
debug = false
Other
Modpacks
Yes.
Refactoring
Yes.
License
MIT License
Copyright (c) 2017 Ian Cronkright
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
AD
Become Premium to remove Ads!
What means Verified?
-
Compatibility: The mod should be compatible with the latest version of Minecraft and be clearly labeled with its supported versions.
-
Functionality: The mod should work as advertised and not cause any game-breaking bugs or crashes.
-
Security: The mod should not contain any malicious code or attempts to steal personal information.
-
Performance: The mod should not cause a significant decrease in the game's performance, such as by causing lag or reducing frame rates.
-
Originality: The mod should be original and not a copy of someone else's work.
-
Up-to-date: The mod should be regularly updated to fix bugs, improve performance, and maintain compatibility with the latest version of Minecraft.
-
Support: The mod should have an active developer who provides support and troubleshooting assistance to users.
-
License: The mod should be released under a clear and open source license that allows others to use, modify, and redistribute the code.
-
Documentation: The mod should come with clear and detailed documentation on how to install and use it.
AD
Become Premium to remove Ads!
How to Install
Download Forge & Java
Download Forge from the offical Site or here. If you dont have Java installed then install it now from here. After Downloading Forge you can run the file with Java.
Prepare
Lounch Minecraft and select your Forge istallation as Version this will create a Folder called Mods.
Add Mods
Type Win+R and type %appdata% and open the .minecraft Folder. There will you find your Folder called Mods. Place all Mods you want to play in this Folder
Enjoy
You are now Ready. Re-start your Game and start Playing.