Necesse Wiki - User contributions [en]

Demon bar

2026-04-10T16:09:10Z

Jamesp1989:

#REDIRECT [[Demonic_Bar]]

Demon bar

2026-04-10T16:08:49Z

Jamesp1989: Redirected page to Demonic Bar

#REDIRECT [[Demonic_Bar]]
A demon bar can be crafted at a demon workstation for either 1 gold bar, 3 copper bars, or 2 iron bars. Additionally, it can be dropped by the evil's protector boss.

Modding

2026-02-04T02:53:57Z

Jamesp1989: /* Using a translation inside the game */

Modding is the act of modifying, adding or removing content and features. Mods are created by the community, and shared through the [https://steamcommunity.com/app/1169040/workshop/ Steam Workshop]. They can be anything like adding more items and monsters, adding a new language, changing the textures in the game, adding new features, tweaking balance and much more.

Necesse mods are created using the Java programming language.

__TOC__

== Installing and using mods ==
=== Steam Workshop ===
Modders usually share their mods on the [https://steamcommunity.com/app/1169040/workshop/ Steam Workshop]. If you subscribe to a mod, the next time you launch the game a mods button will appear in the main menu. In this menu you can see the mods you have installed, change their load order, enable or disable them.
=== Dedicated servers and local mods ===
For dedicated servers to have mods, they must find and download the mod jar file. Many modders give links to where they can be downloaded on the mods Workshop page. Once you have the jar file, you have to put it inside a mods folder, depending on your system. 
If the folder does not exist on your system, you can create one yourself. 
'''Note: ONLY the jar file is needed for the mod to be active, the rest of the files within the example mod are for gradle tasks to help make testing easier''' 

* '''Windows:''' %APPDATA%/Necesse/mods/
* '''Linux:''' ~/.config/Necesse/mods
* '''Mac:''' ~/Library/Application Support/Necesse/mods/

* '''Windows dedicated Server over steamcmd '''

Install your server as usual with steamcmd with the AppID 1169370.

Create then in your server install directory a new folder mods
as example: c:\Servers\Necesse\mods

Then you have to edit the server start parameters (in startserver-nogui.bat)

default:
start jre\bin\java.exe -jar Server.jar -nogui %*

edit in:
start jre\bin\java.exe -jar Server.jar -nogui -datadir .\data -mod .\mods

Then copy your .jar mod files downloaded over the steam workshop as explained earlier in this thread into the mods folder. The server will recognize on startup the mods in the folder and loads them.

== Texture/Resource packs ==
Texture packs are not officially supported, except through the modding system. However, it is still possible to overwrite existing textures inside the game. To do so, follow the steps:

# Download the official textures, found on the [https://discord.gg/FAFgrKD Official Discord server], in a pinned message inside the wiki channel.
# Browse to the games install directory. You can do so by right-clicking the game in your Steam library -> Manage -> Browse local files.
# Extract the texture files into "<Necesse install directory>/res". If the "res" folder does not exist, you have to create it yourself.

The next time you launch the game, the textures will be loaded from those extracted files. This means you can edit or replace any of the files and that will then be loaded instead.

== Creating mods ==
Necesse mods are created using the Java programming language. This place is not for you to learn Java, there are plenty of tutorials and resources on that out on the internet already.

Mods are packaged inside a jar file for the game to load during runtime. When modding, it's a good idea to have a decompiler (included in most IDEs). The source code won't be released yet (if ever), and many topics are not explained thoroughly yet. This means you often have to rely on decompiling classes and checking out how they are done in the core game.

[https://discord.gg/FAFgrKD The Official Discord Server] has a channel dedicated to modding where you can ask questions, get help and request new modding features for the game and all other things Necesse modding.

=== New in v. 0.21.27 ===
''If you are just starting out modding, you can skip this section.'' 
In version 0.21.27 and forward, the game has changed the Java runtime environment it used. If you try to launch the game with the old runtime environment, you may run into crashes or other problems. You can download the runtime currently being used [https://adoptium.net/temurin/releases/?version=17 here]. To help with compatibility, the language level is still version 8. In IntelliJ, you can change your JDK and language level by going to File -> Project Structure... -> Project. Make sure that Gradle is also using the correct JDK by going to File -> Settings -> Build, Execution and Deployment -> Build Tools -> Gradle -> Gradle JVM. The example project has been updated to use this new Java and Gradle version.

=== Getting started and example project ===
To get started on modding, there is an '''[https://github.com/DrFair/ExampleMod official example project you can download, found on Github].''' It includes basic stuff like adding items, tiles, objects, monsters, recipes and more. It also includes build tools using Gradle to easily compile and structure your mod so that it can be read and loaded by the game, as well as development tools like loading your in-development mod, so that you can upload it to the Steam Workshop when complete.

=== Modding tools ===
* An integrated development environment (IDE). For example [https://www.jetbrains.com/idea/download Intellij IDEA Community] which is free.
* A Java development kit. The game is built using Adoptium Java17, which you can find [https://adoptium.net/temurin/releases/?version=17 here] but for compatibility reasons is still only using language level 8. If you are using the Intellij IDE, this is not needed as a JDK is already included in it. Make sure you are using language level 8 by going to File -> Project Structure... -> Language Level.
* An image editing tool, like pixel art editors [https://www.aseprite.org/ Aseprite] or [https://www.pyxeledit.com/ Pyxel Edit].
* An audio editing tool, like [https://www.audacityteam.org/ Audacity] or [https://www.reaper.fm/ REAPER].

=== Setting up ===
If you have downloaded the example project, it can be loaded using your IDE and almost everything will already be set up for you. All you have to do is configure your ''build.gradle'' file with the correct mod info and the games install directory. Once done, it will prompt you to refresh the project.

=== Running and testing your mod ===
[[File:Mod runClient Task.png|thumb|Image of where the gradle task can be found inside Intellij]]
To run your in-development mod, you will need to launch the game with ''-mod <folder path with your mod jar>'' option. This is already done for you if you are using the example project and run the ''runClient'' Gradle task. It can be found in the far-right toolbar inside Intellij (see image). Using this launch option will also allow you to upload your mod to Workshop once it is complete.

==== Testing multiplayer ====
To test multiplayer, you can run one client with the ''runClient'' Gradle task, and another with the ''runDevClient'' Gradle task. One client should host the game, while the other should connect through the multiplayer menu. The hosted game should show up as a LAN server, or you can manually connect to it by using "localhost" as IP the address. The dev client will load into the game with a different authentication ID, allowing you to have 2 clients inside the same server.

It's also important to test the dedicated server since it does not have access to the resources the clients load on startup. To do this, run the ''runServer'' Gradle task, and run your regular client at the same time. Same as above, you should then be able to see the game inside the multiplayer menu as a LAN server, or you can manually connect to it by using "localhost" as IP the address.

=== Mod info file ===
Note: If you are using the example mod, you can skip this section as it is generated for you using the values you set inside the ''build.gradle'' file.

Every mod must have a ''mod.info'' file in their jar's top path. The file structure is custom, but very similar to JSON. It's used throughout the game's saved files.
The file must have these fields:
* '''id''' - The unique ID of your mod. Must be all lowercase and cannot use special characters.
* '''name''' - The display name of your mod.
* '''version''' - The version of your mod.
* '''gameVersion''' - The target game version of your mod.
* '''description''' - A short description of your mod.
* '''author''' - Your name
* '''dependencies''' (optional) - Your mods dependencies are formatted in their IDs and array. Like this: [exammple.mod, other.mod]
* '''optionalDependecies''' (optional) - Your mods optional dependencies. They are used together with your dependencies to automatically make a load order for mods.
* '''clientside''' (optional) - true/false, if your mod is client/server-side only. This makes it possible for clients to connect to servers without the server needing the mod and vice versa. Defaults to false.

'''Important notes about your mod.info file:'''
# Your id should be unique to the mod and never change between versions. A good example for id is "<your name>.<mod name>".
# Avoid special characters that might inflict with the format, like commas, quotes, etc. This will probably be changed later, and you’ll be able to escape characters, just like in Java.

Example of a mod.info file:
<syntaxhighlight lang="ini">
{
id = fair.examplemod,
name = Example Mod,
version = 1.0,
gameVersion = 1.1.1,
description = Just an example mod,
author = Fair
}
</syntaxhighlight>

=== Mod entry class ===
Your mod needs an entry class. This is where the game loads your mod from and calls initialization methods. Create a class with the @ModEntry annotation to tell the game that's where your mod starts.

'''Important notes about your @ModEntry class:'''
# Make sure your mod only has one @ModEntry annotation. The game will stop looking for more when found one.
# Make sure the class does NOT have a constructor.

Example for your mod entry class:
<syntaxhighlight lang=Java>
import necesse.engine.modLoader.annotations.ModEntry;

@ModEntry
public class ExampleMod {

public void init() {
System.out.println("Hello world from my example mod!");
}

}
</syntaxhighlight>
The game will look for specific methods within your @ModEntry class. Here's a description of them:

==== public void preInit() ====
This method is called before loading of the core game. It should only be used on rare occasions. If you are not sure about it, don't use it.

==== public void init() ====
This method is called after the core game has been loaded. Here you should register your own tiles, objects, items, mobs and so on.

The general order in which you should register your mod objects to avoid issues are (not forced):
# Tiles
# Objects
# Biomes
# Buffs
# Global ingredients
# Recipe techs
# Items
# Enchantments
# Mobs
# Pickup entities and projectiles
# Level, world events, level data and settlers
# Containers
# World generators
# Packets
# Quests
# Other

==== public void initResources() ====
This method is called only on the client and should load any extra resources your mod uses that the game doesn't automatically load.

The resources will be loaded from a resource folder. You can read more about this in a later section.

Example: Assign a texture:

<syntaxhighlight lang="Java" inline=1>GameTexture texture = GameTexture.fromFile("path/to/file")</syntaxhighlight>
If you have a texture at resources/texture.png you can load it using <syntaxhighlight lang="Java" inline=1>GameTexture.fromFile("texture")</syntaxhighlight>

All sound (.ogg) files need to be placed in resources/sound folder and can be loaded using

<syntaxhighlight lang="Java" inline=1>GameSound.fromFile("path/to/file")</syntaxhighlight>

For example, a song placed in resources/sound/music/MySong.ogg would be loaded as <syntaxhighlight lang="Java" inline=1>GameSound.fromFile("music/MySong")</syntaxhighlight>, ommiting resources/sound

For information on music paths to override music, look at <syntaxhighlight lang="Java" inline=1>MusicRegistry.registerCore</syntaxhighlight>

==== public void postInit() ====
This method is called after the game is done loading all its core, mods and resources.

This is where you should register recipes, create or modify loot tables and spawn tables and register chat commands.

==== public void dispose() ====
This method is called when the game closes. If you have anything that needs to be disposed, that the game doesn't already dispose on it's own, do it here.

Things like textured loaded using <syntaxhighlight lang="Java" inline=1>GameTexture.fromFile(...)</syntaxhighlight> and sounds are automatically disposed.

=== Building your mod ===
If you are using the example project, a lot of this is already done for you. Simply run the ''buildModJar'' Gradle task, and it will generate the jar inside the ./build/jar folder.

For the game to recognize your jar, it has to follow a specific structure:
;ExampleMod.jar
: ↳ resources
:: ↳ Your resource files
: ↳ Java class files
: ↳ mod.info file

=== Uploading your mod ===
[[File:Upload mod.png|thumb|Image of the upload button when mod is loaded from development]]
To upload your mod to the Steam workshop, a few conditions have to be met:
* Must be enabled
* Must have a preview.png file in the resources folder
* Must be loaded through the -mod launch option (this is done automatically in the example project when running the ''runClient'' Gradle task. You can find more info about this under the beginning of the setting up section).
When all of these conditions are met, a button to upload your mod will appear when you select it inside the main menu mods screen. Click this and it will walk you through uploading to workshop. When you first upload, the mod will be hidden and only you will be able to see it. You can change this when you are ready to launch on your mods workshop page.

=== Localization ===
Localization files are needed to give your tiles, objects, items, mobs and other things names. The files should be placed inside the resources/locale folder, and be named the same as the language they are using. Example: en.lang for the english translation.

You can also see how the localization file is structured inside the example mod project.

==== The file structure ====
The file is divided up into categories and keys. If your item has the localization ''item.exampleitem'', it means that it's under the ''item'' category and has the key ''exampleitem''.

The language file is read line by line in order. If one line is a category change, all the next keys will be under that category. Here's an example:
<syntaxhighlight lang="ini">
[mycategory]
mykey=Text
otherkey=Other text

[newcategory]
differentkey=Different text

[item]
exampleitem=Example item
</syntaxhighlight>
Translations can have replacements that can be done in runtime. To add a replacement key in your translation, add a <key> somewhere. The key can be anything like <name>, <number> etc. Example: <syntaxhighlight lang="ini" inline=1>mobhealth=Mob health: <health></syntaxhighlight>

==== Using a translation inside the game ====
<syntaxhighlight lang="Java" inline=1>Localization.translate(category, key)</syntaxhighlight>
<syntaxhighlight lang="Java" inline=1>Localization.translate(category, key, replaceKey1, replaceString1, replaceKey2, replaceString2, ...)</syntaxhighlight>

A lot of places also use the GameMessage class. This is essentially a localizable string, by using LocalMessage which extends GameMessage. Goes the same as above:
<syntaxhighlight lang="Java" inline=1>new LocalMessage(category, key, replaceKey1, replaceString1, replaceKey2, replaceString2, ...)</syntaxhighlight>

If you don't want to use a translation, you can also just give it a static string with <syntaxhighlight lang="Java" inline=1>new StaticMessage(string...)</syntaxhighlight>

=== Resources ===
For the game to load your resources, they have to be placed inside a resources folder in your mod jar.

Using this, it is also possible to overwrite existing ingame textures by placing another texture at the exact same path as the core game ones. In the Discord server, there is a wiki channel with a pinned message where the core textures can be downloaded and used for modding and this wiki.

This also means that your resource files can get overwritten by other mods, so try and keep your file names unique.

Resource loading happens automatically for any files in the resources folder. But some things will look at specific subfolders to load their textures. Examples:
* '''Items''' - items/<item stringiD>
* '''Buffs''' - buffs/<buff stringiD>
* '''Biomes''' - biomes/<biome stringiD>
* '''Projectiles''' - projectiles/<projectile stringiD>

== More documentation ==
Until more documentation gets migrated and added to this wiki, you can use the old documentation here: [https://docs.google.com/document/u/1/d/e/2PACX-1vTexy0ZwJmztm6KhvwUCpSbgdNFV5hxUOr_6rSiCyqvjlj80Sj28Alenodq6AbOfnKaWoj-zv0iziyL/pub Published Google docs file]
[[Modding Snippets]] Has examples of other modders coding work that can be used to help you out.

== Accessing Necesse Java files ==
[[File:Decompile1.png|thumb|Decompile1]]
[[File:Decompile2.png|thumb|Decompile2]]
[[File:Decompile3.png|thumb|Decompile3]]
[[File:Decompile4.png|thumb|Decompile4]]
using the IDE mentioned in [[Modding#Modding_tools|Modding Tools]], you can decompile java files and take a peek at the core game values. 
 

{{stub|reason = Need to reformat this section}} 
'''Note: Java may need to be installed for this process''' 
You probably need to have Java installed.(external links not allowed) 
Download and install the Windows x64 .msi file 

'''Rough Transcript from Discord User Snoobinoob, to be refined:''' 
Open up IntelliJ IDEA and create a new Java project wherever 
File > New > Project... 
Can leave all settings as is 
Once the project is created, open up the project structure 
File > Project Structure... (Ctrl+Alt+Shift+S) 
select "Modules" from the left navigaiton pane 
Click the dependencies tab on the top-right-ish (Decompile1) 
Click the + icon to add a new module and choose "JARs or Directories" (Decompile2) 
Browse to the steam files location of Necesse.jar 
Should be something like: C:\Program Files (x86)\Steam\steamapps\common\Necesse\Necesse.jar 
Should see this (or similar) after clicking the +, choosing JARs or Directories, and browsing to the Necesse.jar location (Decompile3) 
Click OK, and you should now see Necesse.jar in the list of dependencies in the previous Modules window 
Click OK again to close the project structure window 
Necesse.jar should now be visible in External Libraries (Decompile4) 
Everything should now be set up, so you can search via the Navigate > Search Everywhere menu option 
Exactly what to search is up to you, and not always the most obvious

Modding

2026-02-04T02:50:38Z

Jamesp1989: /* The file structure */

Modding is the act of modifying, adding or removing content and features. Mods are created by the community, and shared through the [https://steamcommunity.com/app/1169040/workshop/ Steam Workshop]. They can be anything like adding more items and monsters, adding a new language, changing the textures in the game, adding new features, tweaking balance and much more.

Necesse mods are created using the Java programming language.

__TOC__

== Installing and using mods ==
=== Steam Workshop ===
Modders usually share their mods on the [https://steamcommunity.com/app/1169040/workshop/ Steam Workshop]. If you subscribe to a mod, the next time you launch the game a mods button will appear in the main menu. In this menu you can see the mods you have installed, change their load order, enable or disable them.
=== Dedicated servers and local mods ===
For dedicated servers to have mods, they must find and download the mod jar file. Many modders give links to where they can be downloaded on the mods Workshop page. Once you have the jar file, you have to put it inside a mods folder, depending on your system. 
If the folder does not exist on your system, you can create one yourself. 
'''Note: ONLY the jar file is needed for the mod to be active, the rest of the files within the example mod are for gradle tasks to help make testing easier''' 

* '''Windows:''' %APPDATA%/Necesse/mods/
* '''Linux:''' ~/.config/Necesse/mods
* '''Mac:''' ~/Library/Application Support/Necesse/mods/

* '''Windows dedicated Server over steamcmd '''

Install your server as usual with steamcmd with the AppID 1169370.

Create then in your server install directory a new folder mods
as example: c:\Servers\Necesse\mods

Then you have to edit the server start parameters (in startserver-nogui.bat)

default:
start jre\bin\java.exe -jar Server.jar -nogui %*

edit in:
start jre\bin\java.exe -jar Server.jar -nogui -datadir .\data -mod .\mods

Then copy your .jar mod files downloaded over the steam workshop as explained earlier in this thread into the mods folder. The server will recognize on startup the mods in the folder and loads them.

== Texture/Resource packs ==
Texture packs are not officially supported, except through the modding system. However, it is still possible to overwrite existing textures inside the game. To do so, follow the steps:

# Download the official textures, found on the [https://discord.gg/FAFgrKD Official Discord server], in a pinned message inside the wiki channel.
# Browse to the games install directory. You can do so by right-clicking the game in your Steam library -> Manage -> Browse local files.
# Extract the texture files into "<Necesse install directory>/res". If the "res" folder does not exist, you have to create it yourself.

The next time you launch the game, the textures will be loaded from those extracted files. This means you can edit or replace any of the files and that will then be loaded instead.

== Creating mods ==
Necesse mods are created using the Java programming language. This place is not for you to learn Java, there are plenty of tutorials and resources on that out on the internet already.

Mods are packaged inside a jar file for the game to load during runtime. When modding, it's a good idea to have a decompiler (included in most IDEs). The source code won't be released yet (if ever), and many topics are not explained thoroughly yet. This means you often have to rely on decompiling classes and checking out how they are done in the core game.

[https://discord.gg/FAFgrKD The Official Discord Server] has a channel dedicated to modding where you can ask questions, get help and request new modding features for the game and all other things Necesse modding.

=== New in v. 0.21.27 ===
''If you are just starting out modding, you can skip this section.'' 
In version 0.21.27 and forward, the game has changed the Java runtime environment it used. If you try to launch the game with the old runtime environment, you may run into crashes or other problems. You can download the runtime currently being used [https://adoptium.net/temurin/releases/?version=17 here]. To help with compatibility, the language level is still version 8. In IntelliJ, you can change your JDK and language level by going to File -> Project Structure... -> Project. Make sure that Gradle is also using the correct JDK by going to File -> Settings -> Build, Execution and Deployment -> Build Tools -> Gradle -> Gradle JVM. The example project has been updated to use this new Java and Gradle version.

=== Getting started and example project ===
To get started on modding, there is an '''[https://github.com/DrFair/ExampleMod official example project you can download, found on Github].''' It includes basic stuff like adding items, tiles, objects, monsters, recipes and more. It also includes build tools using Gradle to easily compile and structure your mod so that it can be read and loaded by the game, as well as development tools like loading your in-development mod, so that you can upload it to the Steam Workshop when complete.

=== Modding tools ===
* An integrated development environment (IDE). For example [https://www.jetbrains.com/idea/download Intellij IDEA Community] which is free.
* A Java development kit. The game is built using Adoptium Java17, which you can find [https://adoptium.net/temurin/releases/?version=17 here] but for compatibility reasons is still only using language level 8. If you are using the Intellij IDE, this is not needed as a JDK is already included in it. Make sure you are using language level 8 by going to File -> Project Structure... -> Language Level.
* An image editing tool, like pixel art editors [https://www.aseprite.org/ Aseprite] or [https://www.pyxeledit.com/ Pyxel Edit].
* An audio editing tool, like [https://www.audacityteam.org/ Audacity] or [https://www.reaper.fm/ REAPER].

=== Setting up ===
If you have downloaded the example project, it can be loaded using your IDE and almost everything will already be set up for you. All you have to do is configure your ''build.gradle'' file with the correct mod info and the games install directory. Once done, it will prompt you to refresh the project.

=== Running and testing your mod ===
[[File:Mod runClient Task.png|thumb|Image of where the gradle task can be found inside Intellij]]
To run your in-development mod, you will need to launch the game with ''-mod <folder path with your mod jar>'' option. This is already done for you if you are using the example project and run the ''runClient'' Gradle task. It can be found in the far-right toolbar inside Intellij (see image). Using this launch option will also allow you to upload your mod to Workshop once it is complete.

==== Testing multiplayer ====
To test multiplayer, you can run one client with the ''runClient'' Gradle task, and another with the ''runDevClient'' Gradle task. One client should host the game, while the other should connect through the multiplayer menu. The hosted game should show up as a LAN server, or you can manually connect to it by using "localhost" as IP the address. The dev client will load into the game with a different authentication ID, allowing you to have 2 clients inside the same server.

It's also important to test the dedicated server since it does not have access to the resources the clients load on startup. To do this, run the ''runServer'' Gradle task, and run your regular client at the same time. Same as above, you should then be able to see the game inside the multiplayer menu as a LAN server, or you can manually connect to it by using "localhost" as IP the address.

=== Mod info file ===
Note: If you are using the example mod, you can skip this section as it is generated for you using the values you set inside the ''build.gradle'' file.

Every mod must have a ''mod.info'' file in their jar's top path. The file structure is custom, but very similar to JSON. It's used throughout the game's saved files.
The file must have these fields:
* '''id''' - The unique ID of your mod. Must be all lowercase and cannot use special characters.
* '''name''' - The display name of your mod.
* '''version''' - The version of your mod.
* '''gameVersion''' - The target game version of your mod.
* '''description''' - A short description of your mod.
* '''author''' - Your name
* '''dependencies''' (optional) - Your mods dependencies are formatted in their IDs and array. Like this: [exammple.mod, other.mod]
* '''optionalDependecies''' (optional) - Your mods optional dependencies. They are used together with your dependencies to automatically make a load order for mods.
* '''clientside''' (optional) - true/false, if your mod is client/server-side only. This makes it possible for clients to connect to servers without the server needing the mod and vice versa. Defaults to false.

'''Important notes about your mod.info file:'''
# Your id should be unique to the mod and never change between versions. A good example for id is "<your name>.<mod name>".
# Avoid special characters that might inflict with the format, like commas, quotes, etc. This will probably be changed later, and you’ll be able to escape characters, just like in Java.

Example of a mod.info file:
<syntaxhighlight lang="ini">
{
id = fair.examplemod,
name = Example Mod,
version = 1.0,
gameVersion = 1.1.1,
description = Just an example mod,
author = Fair
}
</syntaxhighlight>

=== Mod entry class ===
Your mod needs an entry class. This is where the game loads your mod from and calls initialization methods. Create a class with the @ModEntry annotation to tell the game that's where your mod starts.

'''Important notes about your @ModEntry class:'''
# Make sure your mod only has one @ModEntry annotation. The game will stop looking for more when found one.
# Make sure the class does NOT have a constructor.

Example for your mod entry class:
<syntaxhighlight lang=Java>
import necesse.engine.modLoader.annotations.ModEntry;

@ModEntry
public class ExampleMod {

public void init() {
System.out.println("Hello world from my example mod!");
}

}
</syntaxhighlight>
The game will look for specific methods within your @ModEntry class. Here's a description of them:

==== public void preInit() ====
This method is called before loading of the core game. It should only be used on rare occasions. If you are not sure about it, don't use it.

==== public void init() ====
This method is called after the core game has been loaded. Here you should register your own tiles, objects, items, mobs and so on.

The general order in which you should register your mod objects to avoid issues are (not forced):
# Tiles
# Objects
# Biomes
# Buffs
# Global ingredients
# Recipe techs
# Items
# Enchantments
# Mobs
# Pickup entities and projectiles
# Level, world events, level data and settlers
# Containers
# World generators
# Packets
# Quests
# Other

==== public void initResources() ====
This method is called only on the client and should load any extra resources your mod uses that the game doesn't automatically load.

The resources will be loaded from a resource folder. You can read more about this in a later section.

Example: Assign a texture:

<syntaxhighlight lang="Java" inline=1>GameTexture texture = GameTexture.fromFile("path/to/file")</syntaxhighlight>
If you have a texture at resources/texture.png you can load it using <syntaxhighlight lang="Java" inline=1>GameTexture.fromFile("texture")</syntaxhighlight>

All sound (.ogg) files need to be placed in resources/sound folder and can be loaded using

<syntaxhighlight lang="Java" inline=1>GameSound.fromFile("path/to/file")</syntaxhighlight>

For example, a song placed in resources/sound/music/MySong.ogg would be loaded as <syntaxhighlight lang="Java" inline=1>GameSound.fromFile("music/MySong")</syntaxhighlight>, ommiting resources/sound

For information on music paths to override music, look at <syntaxhighlight lang="Java" inline=1>MusicRegistry.registerCore</syntaxhighlight>

==== public void postInit() ====
This method is called after the game is done loading all its core, mods and resources.

This is where you should register recipes, create or modify loot tables and spawn tables and register chat commands.

==== public void dispose() ====
This method is called when the game closes. If you have anything that needs to be disposed, that the game doesn't already dispose on it's own, do it here.

Things like textured loaded using <syntaxhighlight lang="Java" inline=1>GameTexture.fromFile(...)</syntaxhighlight> and sounds are automatically disposed.

=== Building your mod ===
If you are using the example project, a lot of this is already done for you. Simply run the ''buildModJar'' Gradle task, and it will generate the jar inside the ./build/jar folder.

For the game to recognize your jar, it has to follow a specific structure:
;ExampleMod.jar
: ↳ resources
:: ↳ Your resource files
: ↳ Java class files
: ↳ mod.info file

=== Uploading your mod ===
[[File:Upload mod.png|thumb|Image of the upload button when mod is loaded from development]]
To upload your mod to the Steam workshop, a few conditions have to be met:
* Must be enabled
* Must have a preview.png file in the resources folder
* Must be loaded through the -mod launch option (this is done automatically in the example project when running the ''runClient'' Gradle task. You can find more info about this under the beginning of the setting up section).
When all of these conditions are met, a button to upload your mod will appear when you select it inside the main menu mods screen. Click this and it will walk you through uploading to workshop. When you first upload, the mod will be hidden and only you will be able to see it. You can change this when you are ready to launch on your mods workshop page.

=== Localization ===
Localization files are needed to give your tiles, objects, items, mobs and other things names. The files should be placed inside the resources/locale folder, and be named the same as the language they are using. Example: en.lang for the english translation.

You can also see how the localization file is structured inside the example mod project.

==== The file structure ====
The file is divided up into categories and keys. If your item has the localization ''item.exampleitem'', it means that it's under the ''item'' category and has the key ''exampleitem''.

The language file is read line by line in order. If one line is a category change, all the next keys will be under that category. Here's an example:
<syntaxhighlight lang="ini">
[mycategory]
mykey=Text
otherkey=Other text

[newcategory]
differentkey=Different text

[item]
exampleitem=Example item
</syntaxhighlight>
Translations can have replacements that can be done in runtime. To add a replacement key in your translation, add a <key> somewhere. The key can be anything like <name>, <number> etc. Example: <syntaxhighlight lang="ini" inline=1>mobhealth=Mob health: <health></syntaxhighlight>

==== Using a translation inside the game ====
<code>Localization.translate(category, key)</code>
<code>Localization.translate(category, key, replaceKey1, replaceString1, replaceKey2, replaceString2, ...)</code>

A lot of places also use the GameMessage class. This is essentially a localizable string, by using LocalMessage which extends GameMessage. Goes the same as above:
<code>new LocalMessage(category, key, replaceKey1, replaceString1, replaceKey2, replaceString2, ...)</code>

If you don't want to use a translation, you can also just give it a static string with <code>new StaticMessage(string...)</code>

=== Resources ===
For the game to load your resources, they have to be placed inside a resources folder in your mod jar.

Using this, it is also possible to overwrite existing ingame textures by placing another texture at the exact same path as the core game ones. In the Discord server, there is a wiki channel with a pinned message where the core textures can be downloaded and used for modding and this wiki.

This also means that your resource files can get overwritten by other mods, so try and keep your file names unique.

Resource loading happens automatically for any files in the resources folder. But some things will look at specific subfolders to load their textures. Examples:
* '''Items''' - items/<item stringiD>
* '''Buffs''' - buffs/<buff stringiD>
* '''Biomes''' - biomes/<biome stringiD>
* '''Projectiles''' - projectiles/<projectile stringiD>

== More documentation ==
Until more documentation gets migrated and added to this wiki, you can use the old documentation here: [https://docs.google.com/document/u/1/d/e/2PACX-1vTexy0ZwJmztm6KhvwUCpSbgdNFV5hxUOr_6rSiCyqvjlj80Sj28Alenodq6AbOfnKaWoj-zv0iziyL/pub Published Google docs file]
[[Modding Snippets]] Has examples of other modders coding work that can be used to help you out.

== Accessing Necesse Java files ==
[[File:Decompile1.png|thumb|Decompile1]]
[[File:Decompile2.png|thumb|Decompile2]]
[[File:Decompile3.png|thumb|Decompile3]]
[[File:Decompile4.png|thumb|Decompile4]]
using the IDE mentioned in [[Modding#Modding_tools|Modding Tools]], you can decompile java files and take a peek at the core game values. 
 

{{stub|reason = Need to reformat this section}} 
'''Note: Java may need to be installed for this process''' 
You probably need to have Java installed.(external links not allowed) 
Download and install the Windows x64 .msi file 

'''Rough Transcript from Discord User Snoobinoob, to be refined:''' 
Open up IntelliJ IDEA and create a new Java project wherever 
File > New > Project... 
Can leave all settings as is 
Once the project is created, open up the project structure 
File > Project Structure... (Ctrl+Alt+Shift+S) 
select "Modules" from the left navigaiton pane 
Click the dependencies tab on the top-right-ish (Decompile1) 
Click the + icon to add a new module and choose "JARs or Directories" (Decompile2) 
Browse to the steam files location of Necesse.jar 
Should be something like: C:\Program Files (x86)\Steam\steamapps\common\Necesse\Necesse.jar 
Should see this (or similar) after clicking the +, choosing JARs or Directories, and browsing to the Necesse.jar location (Decompile3) 
Click OK, and you should now see Necesse.jar in the list of dependencies in the previous Modules window 
Click OK again to close the project structure window 
Necesse.jar should now be visible in External Libraries (Decompile4) 
Everything should now be set up, so you can search via the Navigate > Search Everywhere menu option 
Exactly what to search is up to you, and not always the most obvious

Modding

2026-02-04T02:49:43Z

Jamesp1989: /* public void dispose() */

Modding is the act of modifying, adding or removing content and features. Mods are created by the community, and shared through the [https://steamcommunity.com/app/1169040/workshop/ Steam Workshop]. They can be anything like adding more items and monsters, adding a new language, changing the textures in the game, adding new features, tweaking balance and much more.

Necesse mods are created using the Java programming language.

__TOC__

== Installing and using mods ==
=== Steam Workshop ===
Modders usually share their mods on the [https://steamcommunity.com/app/1169040/workshop/ Steam Workshop]. If you subscribe to a mod, the next time you launch the game a mods button will appear in the main menu. In this menu you can see the mods you have installed, change their load order, enable or disable them.
=== Dedicated servers and local mods ===
For dedicated servers to have mods, they must find and download the mod jar file. Many modders give links to where they can be downloaded on the mods Workshop page. Once you have the jar file, you have to put it inside a mods folder, depending on your system. 
If the folder does not exist on your system, you can create one yourself. 
'''Note: ONLY the jar file is needed for the mod to be active, the rest of the files within the example mod are for gradle tasks to help make testing easier''' 

* '''Windows:''' %APPDATA%/Necesse/mods/
* '''Linux:''' ~/.config/Necesse/mods
* '''Mac:''' ~/Library/Application Support/Necesse/mods/

* '''Windows dedicated Server over steamcmd '''

Install your server as usual with steamcmd with the AppID 1169370.

Create then in your server install directory a new folder mods
as example: c:\Servers\Necesse\mods

Then you have to edit the server start parameters (in startserver-nogui.bat)

default:
start jre\bin\java.exe -jar Server.jar -nogui %*

edit in:
start jre\bin\java.exe -jar Server.jar -nogui -datadir .\data -mod .\mods

Then copy your .jar mod files downloaded over the steam workshop as explained earlier in this thread into the mods folder. The server will recognize on startup the mods in the folder and loads them.

== Texture/Resource packs ==
Texture packs are not officially supported, except through the modding system. However, it is still possible to overwrite existing textures inside the game. To do so, follow the steps:

# Download the official textures, found on the [https://discord.gg/FAFgrKD Official Discord server], in a pinned message inside the wiki channel.
# Browse to the games install directory. You can do so by right-clicking the game in your Steam library -> Manage -> Browse local files.
# Extract the texture files into "<Necesse install directory>/res". If the "res" folder does not exist, you have to create it yourself.

The next time you launch the game, the textures will be loaded from those extracted files. This means you can edit or replace any of the files and that will then be loaded instead.

== Creating mods ==
Necesse mods are created using the Java programming language. This place is not for you to learn Java, there are plenty of tutorials and resources on that out on the internet already.

Mods are packaged inside a jar file for the game to load during runtime. When modding, it's a good idea to have a decompiler (included in most IDEs). The source code won't be released yet (if ever), and many topics are not explained thoroughly yet. This means you often have to rely on decompiling classes and checking out how they are done in the core game.

[https://discord.gg/FAFgrKD The Official Discord Server] has a channel dedicated to modding where you can ask questions, get help and request new modding features for the game and all other things Necesse modding.

=== New in v. 0.21.27 ===
''If you are just starting out modding, you can skip this section.'' 
In version 0.21.27 and forward, the game has changed the Java runtime environment it used. If you try to launch the game with the old runtime environment, you may run into crashes or other problems. You can download the runtime currently being used [https://adoptium.net/temurin/releases/?version=17 here]. To help with compatibility, the language level is still version 8. In IntelliJ, you can change your JDK and language level by going to File -> Project Structure... -> Project. Make sure that Gradle is also using the correct JDK by going to File -> Settings -> Build, Execution and Deployment -> Build Tools -> Gradle -> Gradle JVM. The example project has been updated to use this new Java and Gradle version.

=== Getting started and example project ===
To get started on modding, there is an '''[https://github.com/DrFair/ExampleMod official example project you can download, found on Github].''' It includes basic stuff like adding items, tiles, objects, monsters, recipes and more. It also includes build tools using Gradle to easily compile and structure your mod so that it can be read and loaded by the game, as well as development tools like loading your in-development mod, so that you can upload it to the Steam Workshop when complete.

=== Modding tools ===
* An integrated development environment (IDE). For example [https://www.jetbrains.com/idea/download Intellij IDEA Community] which is free.
* A Java development kit. The game is built using Adoptium Java17, which you can find [https://adoptium.net/temurin/releases/?version=17 here] but for compatibility reasons is still only using language level 8. If you are using the Intellij IDE, this is not needed as a JDK is already included in it. Make sure you are using language level 8 by going to File -> Project Structure... -> Language Level.
* An image editing tool, like pixel art editors [https://www.aseprite.org/ Aseprite] or [https://www.pyxeledit.com/ Pyxel Edit].
* An audio editing tool, like [https://www.audacityteam.org/ Audacity] or [https://www.reaper.fm/ REAPER].

=== Setting up ===
If you have downloaded the example project, it can be loaded using your IDE and almost everything will already be set up for you. All you have to do is configure your ''build.gradle'' file with the correct mod info and the games install directory. Once done, it will prompt you to refresh the project.

=== Running and testing your mod ===
[[File:Mod runClient Task.png|thumb|Image of where the gradle task can be found inside Intellij]]
To run your in-development mod, you will need to launch the game with ''-mod <folder path with your mod jar>'' option. This is already done for you if you are using the example project and run the ''runClient'' Gradle task. It can be found in the far-right toolbar inside Intellij (see image). Using this launch option will also allow you to upload your mod to Workshop once it is complete.

==== Testing multiplayer ====
To test multiplayer, you can run one client with the ''runClient'' Gradle task, and another with the ''runDevClient'' Gradle task. One client should host the game, while the other should connect through the multiplayer menu. The hosted game should show up as a LAN server, or you can manually connect to it by using "localhost" as IP the address. The dev client will load into the game with a different authentication ID, allowing you to have 2 clients inside the same server.

It's also important to test the dedicated server since it does not have access to the resources the clients load on startup. To do this, run the ''runServer'' Gradle task, and run your regular client at the same time. Same as above, you should then be able to see the game inside the multiplayer menu as a LAN server, or you can manually connect to it by using "localhost" as IP the address.

=== Mod info file ===
Note: If you are using the example mod, you can skip this section as it is generated for you using the values you set inside the ''build.gradle'' file.

Every mod must have a ''mod.info'' file in their jar's top path. The file structure is custom, but very similar to JSON. It's used throughout the game's saved files.
The file must have these fields:
* '''id''' - The unique ID of your mod. Must be all lowercase and cannot use special characters.
* '''name''' - The display name of your mod.
* '''version''' - The version of your mod.
* '''gameVersion''' - The target game version of your mod.
* '''description''' - A short description of your mod.
* '''author''' - Your name
* '''dependencies''' (optional) - Your mods dependencies are formatted in their IDs and array. Like this: [exammple.mod, other.mod]
* '''optionalDependecies''' (optional) - Your mods optional dependencies. They are used together with your dependencies to automatically make a load order for mods.
* '''clientside''' (optional) - true/false, if your mod is client/server-side only. This makes it possible for clients to connect to servers without the server needing the mod and vice versa. Defaults to false.

'''Important notes about your mod.info file:'''
# Your id should be unique to the mod and never change between versions. A good example for id is "<your name>.<mod name>".
# Avoid special characters that might inflict with the format, like commas, quotes, etc. This will probably be changed later, and you’ll be able to escape characters, just like in Java.

Example of a mod.info file:
<syntaxhighlight lang="ini">
{
id = fair.examplemod,
name = Example Mod,
version = 1.0,
gameVersion = 1.1.1,
description = Just an example mod,
author = Fair
}
</syntaxhighlight>

=== Mod entry class ===
Your mod needs an entry class. This is where the game loads your mod from and calls initialization methods. Create a class with the @ModEntry annotation to tell the game that's where your mod starts.

'''Important notes about your @ModEntry class:'''
# Make sure your mod only has one @ModEntry annotation. The game will stop looking for more when found one.
# Make sure the class does NOT have a constructor.

Example for your mod entry class:
<syntaxhighlight lang=Java>
import necesse.engine.modLoader.annotations.ModEntry;

@ModEntry
public class ExampleMod {

public void init() {
System.out.println("Hello world from my example mod!");
}

}
</syntaxhighlight>
The game will look for specific methods within your @ModEntry class. Here's a description of them:

==== public void preInit() ====
This method is called before loading of the core game. It should only be used on rare occasions. If you are not sure about it, don't use it.

==== public void init() ====
This method is called after the core game has been loaded. Here you should register your own tiles, objects, items, mobs and so on.

The general order in which you should register your mod objects to avoid issues are (not forced):
# Tiles
# Objects
# Biomes
# Buffs
# Global ingredients
# Recipe techs
# Items
# Enchantments
# Mobs
# Pickup entities and projectiles
# Level, world events, level data and settlers
# Containers
# World generators
# Packets
# Quests
# Other

==== public void initResources() ====
This method is called only on the client and should load any extra resources your mod uses that the game doesn't automatically load.

The resources will be loaded from a resource folder. You can read more about this in a later section.

Example: Assign a texture:

<syntaxhighlight lang="Java" inline=1>GameTexture texture = GameTexture.fromFile("path/to/file")</syntaxhighlight>
If you have a texture at resources/texture.png you can load it using <syntaxhighlight lang="Java" inline=1>GameTexture.fromFile("texture")</syntaxhighlight>

All sound (.ogg) files need to be placed in resources/sound folder and can be loaded using

<syntaxhighlight lang="Java" inline=1>GameSound.fromFile("path/to/file")</syntaxhighlight>

For example, a song placed in resources/sound/music/MySong.ogg would be loaded as <syntaxhighlight lang="Java" inline=1>GameSound.fromFile("music/MySong")</syntaxhighlight>, ommiting resources/sound

For information on music paths to override music, look at <syntaxhighlight lang="Java" inline=1>MusicRegistry.registerCore</syntaxhighlight>

==== public void postInit() ====
This method is called after the game is done loading all its core, mods and resources.

This is where you should register recipes, create or modify loot tables and spawn tables and register chat commands.

==== public void dispose() ====
This method is called when the game closes. If you have anything that needs to be disposed, that the game doesn't already dispose on it's own, do it here.

Things like textured loaded using <syntaxhighlight lang="Java" inline=1>GameTexture.fromFile(...)</syntaxhighlight> and sounds are automatically disposed.

=== Building your mod ===
If you are using the example project, a lot of this is already done for you. Simply run the ''buildModJar'' Gradle task, and it will generate the jar inside the ./build/jar folder.

For the game to recognize your jar, it has to follow a specific structure:
;ExampleMod.jar
: ↳ resources
:: ↳ Your resource files
: ↳ Java class files
: ↳ mod.info file

=== Uploading your mod ===
[[File:Upload mod.png|thumb|Image of the upload button when mod is loaded from development]]
To upload your mod to the Steam workshop, a few conditions have to be met:
* Must be enabled
* Must have a preview.png file in the resources folder
* Must be loaded through the -mod launch option (this is done automatically in the example project when running the ''runClient'' Gradle task. You can find more info about this under the beginning of the setting up section).
When all of these conditions are met, a button to upload your mod will appear when you select it inside the main menu mods screen. Click this and it will walk you through uploading to workshop. When you first upload, the mod will be hidden and only you will be able to see it. You can change this when you are ready to launch on your mods workshop page.

=== Localization ===
Localization files are needed to give your tiles, objects, items, mobs and other things names. The files should be placed inside the resources/locale folder, and be named the same as the language they are using. Example: en.lang for the english translation.

You can also see how the localization file is structured inside the example mod project.

==== The file structure ====
The file is divided up into categories and keys. If your item has the localization ''item.exampleitem'', it means that it's under the ''item'' category and has the key ''exampleitem''.

The language file is read line by line in order. If one line is a category change, all the next keys will be under that category. Here's an example:
<syntaxhighlight lang="ini">
[mycategory]
mykey=Text
otherkey=Other text

[newcategory]
differentkey=Different text

[item]
exampleitem=Example item
</syntaxhighlight>
Translations can have replacements that can be done in runtime. To add a replacement key in your translation, add a <key> somewhere. The key can be anything like <name>, <number> etc. Example: <code>mobhealth=Mob health: <health></code>

==== Using a translation inside the game ====
<code>Localization.translate(category, key)</code>
<code>Localization.translate(category, key, replaceKey1, replaceString1, replaceKey2, replaceString2, ...)</code>

A lot of places also use the GameMessage class. This is essentially a localizable string, by using LocalMessage which extends GameMessage. Goes the same as above:
<code>new LocalMessage(category, key, replaceKey1, replaceString1, replaceKey2, replaceString2, ...)</code>

If you don't want to use a translation, you can also just give it a static string with <code>new StaticMessage(string...)</code>

=== Resources ===
For the game to load your resources, they have to be placed inside a resources folder in your mod jar.

Using this, it is also possible to overwrite existing ingame textures by placing another texture at the exact same path as the core game ones. In the Discord server, there is a wiki channel with a pinned message where the core textures can be downloaded and used for modding and this wiki.

This also means that your resource files can get overwritten by other mods, so try and keep your file names unique.

Resource loading happens automatically for any files in the resources folder. But some things will look at specific subfolders to load their textures. Examples:
* '''Items''' - items/<item stringiD>
* '''Buffs''' - buffs/<buff stringiD>
* '''Biomes''' - biomes/<biome stringiD>
* '''Projectiles''' - projectiles/<projectile stringiD>

== More documentation ==
Until more documentation gets migrated and added to this wiki, you can use the old documentation here: [https://docs.google.com/document/u/1/d/e/2PACX-1vTexy0ZwJmztm6KhvwUCpSbgdNFV5hxUOr_6rSiCyqvjlj80Sj28Alenodq6AbOfnKaWoj-zv0iziyL/pub Published Google docs file]
[[Modding Snippets]] Has examples of other modders coding work that can be used to help you out.

== Accessing Necesse Java files ==
[[File:Decompile1.png|thumb|Decompile1]]
[[File:Decompile2.png|thumb|Decompile2]]
[[File:Decompile3.png|thumb|Decompile3]]
[[File:Decompile4.png|thumb|Decompile4]]
using the IDE mentioned in [[Modding#Modding_tools|Modding Tools]], you can decompile java files and take a peek at the core game values. 
 

{{stub|reason = Need to reformat this section}} 
'''Note: Java may need to be installed for this process''' 
You probably need to have Java installed.(external links not allowed) 
Download and install the Windows x64 .msi file 

'''Rough Transcript from Discord User Snoobinoob, to be refined:''' 
Open up IntelliJ IDEA and create a new Java project wherever 
File > New > Project... 
Can leave all settings as is 
Once the project is created, open up the project structure 
File > Project Structure... (Ctrl+Alt+Shift+S) 
select "Modules" from the left navigaiton pane 
Click the dependencies tab on the top-right-ish (Decompile1) 
Click the + icon to add a new module and choose "JARs or Directories" (Decompile2) 
Browse to the steam files location of Necesse.jar 
Should be something like: C:\Program Files (x86)\Steam\steamapps\common\Necesse\Necesse.jar 
Should see this (or similar) after clicking the +, choosing JARs or Directories, and browsing to the Necesse.jar location (Decompile3) 
Click OK, and you should now see Necesse.jar in the list of dependencies in the previous Modules window 
Click OK again to close the project structure window 
Necesse.jar should now be visible in External Libraries (Decompile4) 
Everything should now be set up, so you can search via the Navigate > Search Everywhere menu option 
Exactly what to search is up to you, and not always the most obvious

Modding

2026-02-04T02:47:54Z

Jamesp1989: moved to syntax highlighter

Modding is the act of modifying, adding or removing content and features. Mods are created by the community, and shared through the [https://steamcommunity.com/app/1169040/workshop/ Steam Workshop]. They can be anything like adding more items and monsters, adding a new language, changing the textures in the game, adding new features, tweaking balance and much more.

Necesse mods are created using the Java programming language.

__TOC__

== Installing and using mods ==
=== Steam Workshop ===
Modders usually share their mods on the [https://steamcommunity.com/app/1169040/workshop/ Steam Workshop]. If you subscribe to a mod, the next time you launch the game a mods button will appear in the main menu. In this menu you can see the mods you have installed, change their load order, enable or disable them.
=== Dedicated servers and local mods ===
For dedicated servers to have mods, they must find and download the mod jar file. Many modders give links to where they can be downloaded on the mods Workshop page. Once you have the jar file, you have to put it inside a mods folder, depending on your system. 
If the folder does not exist on your system, you can create one yourself. 
'''Note: ONLY the jar file is needed for the mod to be active, the rest of the files within the example mod are for gradle tasks to help make testing easier''' 

* '''Windows:''' %APPDATA%/Necesse/mods/
* '''Linux:''' ~/.config/Necesse/mods
* '''Mac:''' ~/Library/Application Support/Necesse/mods/

* '''Windows dedicated Server over steamcmd '''

Install your server as usual with steamcmd with the AppID 1169370.

Create then in your server install directory a new folder mods
as example: c:\Servers\Necesse\mods

Then you have to edit the server start parameters (in startserver-nogui.bat)

default:
start jre\bin\java.exe -jar Server.jar -nogui %*

edit in:
start jre\bin\java.exe -jar Server.jar -nogui -datadir .\data -mod .\mods

Then copy your .jar mod files downloaded over the steam workshop as explained earlier in this thread into the mods folder. The server will recognize on startup the mods in the folder and loads them.

== Texture/Resource packs ==
Texture packs are not officially supported, except through the modding system. However, it is still possible to overwrite existing textures inside the game. To do so, follow the steps:

# Download the official textures, found on the [https://discord.gg/FAFgrKD Official Discord server], in a pinned message inside the wiki channel.
# Browse to the games install directory. You can do so by right-clicking the game in your Steam library -> Manage -> Browse local files.
# Extract the texture files into "<Necesse install directory>/res". If the "res" folder does not exist, you have to create it yourself.

The next time you launch the game, the textures will be loaded from those extracted files. This means you can edit or replace any of the files and that will then be loaded instead.

== Creating mods ==
Necesse mods are created using the Java programming language. This place is not for you to learn Java, there are plenty of tutorials and resources on that out on the internet already.

Mods are packaged inside a jar file for the game to load during runtime. When modding, it's a good idea to have a decompiler (included in most IDEs). The source code won't be released yet (if ever), and many topics are not explained thoroughly yet. This means you often have to rely on decompiling classes and checking out how they are done in the core game.

[https://discord.gg/FAFgrKD The Official Discord Server] has a channel dedicated to modding where you can ask questions, get help and request new modding features for the game and all other things Necesse modding.

=== New in v. 0.21.27 ===
''If you are just starting out modding, you can skip this section.'' 
In version 0.21.27 and forward, the game has changed the Java runtime environment it used. If you try to launch the game with the old runtime environment, you may run into crashes or other problems. You can download the runtime currently being used [https://adoptium.net/temurin/releases/?version=17 here]. To help with compatibility, the language level is still version 8. In IntelliJ, you can change your JDK and language level by going to File -> Project Structure... -> Project. Make sure that Gradle is also using the correct JDK by going to File -> Settings -> Build, Execution and Deployment -> Build Tools -> Gradle -> Gradle JVM. The example project has been updated to use this new Java and Gradle version.

=== Getting started and example project ===
To get started on modding, there is an '''[https://github.com/DrFair/ExampleMod official example project you can download, found on Github].''' It includes basic stuff like adding items, tiles, objects, monsters, recipes and more. It also includes build tools using Gradle to easily compile and structure your mod so that it can be read and loaded by the game, as well as development tools like loading your in-development mod, so that you can upload it to the Steam Workshop when complete.

=== Modding tools ===
* An integrated development environment (IDE). For example [https://www.jetbrains.com/idea/download Intellij IDEA Community] which is free.
* A Java development kit. The game is built using Adoptium Java17, which you can find [https://adoptium.net/temurin/releases/?version=17 here] but for compatibility reasons is still only using language level 8. If you are using the Intellij IDE, this is not needed as a JDK is already included in it. Make sure you are using language level 8 by going to File -> Project Structure... -> Language Level.
* An image editing tool, like pixel art editors [https://www.aseprite.org/ Aseprite] or [https://www.pyxeledit.com/ Pyxel Edit].
* An audio editing tool, like [https://www.audacityteam.org/ Audacity] or [https://www.reaper.fm/ REAPER].

=== Setting up ===
If you have downloaded the example project, it can be loaded using your IDE and almost everything will already be set up for you. All you have to do is configure your ''build.gradle'' file with the correct mod info and the games install directory. Once done, it will prompt you to refresh the project.

=== Running and testing your mod ===
[[File:Mod runClient Task.png|thumb|Image of where the gradle task can be found inside Intellij]]
To run your in-development mod, you will need to launch the game with ''-mod <folder path with your mod jar>'' option. This is already done for you if you are using the example project and run the ''runClient'' Gradle task. It can be found in the far-right toolbar inside Intellij (see image). Using this launch option will also allow you to upload your mod to Workshop once it is complete.

==== Testing multiplayer ====
To test multiplayer, you can run one client with the ''runClient'' Gradle task, and another with the ''runDevClient'' Gradle task. One client should host the game, while the other should connect through the multiplayer menu. The hosted game should show up as a LAN server, or you can manually connect to it by using "localhost" as IP the address. The dev client will load into the game with a different authentication ID, allowing you to have 2 clients inside the same server.

It's also important to test the dedicated server since it does not have access to the resources the clients load on startup. To do this, run the ''runServer'' Gradle task, and run your regular client at the same time. Same as above, you should then be able to see the game inside the multiplayer menu as a LAN server, or you can manually connect to it by using "localhost" as IP the address.

=== Mod info file ===
Note: If you are using the example mod, you can skip this section as it is generated for you using the values you set inside the ''build.gradle'' file.

Every mod must have a ''mod.info'' file in their jar's top path. The file structure is custom, but very similar to JSON. It's used throughout the game's saved files.
The file must have these fields:
* '''id''' - The unique ID of your mod. Must be all lowercase and cannot use special characters.
* '''name''' - The display name of your mod.
* '''version''' - The version of your mod.
* '''gameVersion''' - The target game version of your mod.
* '''description''' - A short description of your mod.
* '''author''' - Your name
* '''dependencies''' (optional) - Your mods dependencies are formatted in their IDs and array. Like this: [exammple.mod, other.mod]
* '''optionalDependecies''' (optional) - Your mods optional dependencies. They are used together with your dependencies to automatically make a load order for mods.
* '''clientside''' (optional) - true/false, if your mod is client/server-side only. This makes it possible for clients to connect to servers without the server needing the mod and vice versa. Defaults to false.

'''Important notes about your mod.info file:'''
# Your id should be unique to the mod and never change between versions. A good example for id is "<your name>.<mod name>".
# Avoid special characters that might inflict with the format, like commas, quotes, etc. This will probably be changed later, and you’ll be able to escape characters, just like in Java.

Example of a mod.info file:
<syntaxhighlight lang="ini">
{
id = fair.examplemod,
name = Example Mod,
version = 1.0,
gameVersion = 1.1.1,
description = Just an example mod,
author = Fair
}
</syntaxhighlight>

=== Mod entry class ===
Your mod needs an entry class. This is where the game loads your mod from and calls initialization methods. Create a class with the @ModEntry annotation to tell the game that's where your mod starts.

'''Important notes about your @ModEntry class:'''
# Make sure your mod only has one @ModEntry annotation. The game will stop looking for more when found one.
# Make sure the class does NOT have a constructor.

Example for your mod entry class:
<syntaxhighlight lang=Java>
import necesse.engine.modLoader.annotations.ModEntry;

@ModEntry
public class ExampleMod {

public void init() {
System.out.println("Hello world from my example mod!");
}

}
</syntaxhighlight>
The game will look for specific methods within your @ModEntry class. Here's a description of them:

==== public void preInit() ====
This method is called before loading of the core game. It should only be used on rare occasions. If you are not sure about it, don't use it.

==== public void init() ====
This method is called after the core game has been loaded. Here you should register your own tiles, objects, items, mobs and so on.

The general order in which you should register your mod objects to avoid issues are (not forced):
# Tiles
# Objects
# Biomes
# Buffs
# Global ingredients
# Recipe techs
# Items
# Enchantments
# Mobs
# Pickup entities and projectiles
# Level, world events, level data and settlers
# Containers
# World generators
# Packets
# Quests
# Other

==== public void initResources() ====
This method is called only on the client and should load any extra resources your mod uses that the game doesn't automatically load.

The resources will be loaded from a resource folder. You can read more about this in a later section.

Example: Assign a texture:

<syntaxhighlight lang="Java" inline=1>GameTexture texture = GameTexture.fromFile("path/to/file")</syntaxhighlight>
If you have a texture at resources/texture.png you can load it using <syntaxhighlight lang="Java" inline=1>GameTexture.fromFile("texture")</syntaxhighlight>

All sound (.ogg) files need to be placed in resources/sound folder and can be loaded using

<syntaxhighlight lang="Java" inline=1>GameSound.fromFile("path/to/file")</syntaxhighlight>

For example, a song placed in resources/sound/music/MySong.ogg would be loaded as <syntaxhighlight lang="Java" inline=1>GameSound.fromFile("music/MySong")</syntaxhighlight>, ommiting resources/sound

For information on music paths to override music, look at <syntaxhighlight lang="Java" inline=1>MusicRegistry.registerCore</syntaxhighlight>

==== public void postInit() ====
This method is called after the game is done loading all its core, mods and resources.

This is where you should register recipes, create or modify loot tables and spawn tables and register chat commands.

==== public void dispose() ====
This method is called when the game closes. If you have anything that needs to be disposed, that the game doesn't already dispose on it's own, do it here.

Things like textured loaded using <code>GameTexture.fromFile(...)</code> and sounds are automatically disposed.

=== Building your mod ===
If you are using the example project, a lot of this is already done for you. Simply run the ''buildModJar'' Gradle task, and it will generate the jar inside the ./build/jar folder.

For the game to recognize your jar, it has to follow a specific structure:
;ExampleMod.jar
: ↳ resources
:: ↳ Your resource files
: ↳ Java class files
: ↳ mod.info file

=== Uploading your mod ===
[[File:Upload mod.png|thumb|Image of the upload button when mod is loaded from development]]
To upload your mod to the Steam workshop, a few conditions have to be met:
* Must be enabled
* Must have a preview.png file in the resources folder
* Must be loaded through the -mod launch option (this is done automatically in the example project when running the ''runClient'' Gradle task. You can find more info about this under the beginning of the setting up section).
When all of these conditions are met, a button to upload your mod will appear when you select it inside the main menu mods screen. Click this and it will walk you through uploading to workshop. When you first upload, the mod will be hidden and only you will be able to see it. You can change this when you are ready to launch on your mods workshop page.

=== Localization ===
Localization files are needed to give your tiles, objects, items, mobs and other things names. The files should be placed inside the resources/locale folder, and be named the same as the language they are using. Example: en.lang for the english translation.

You can also see how the localization file is structured inside the example mod project.

==== The file structure ====
The file is divided up into categories and keys. If your item has the localization ''item.exampleitem'', it means that it's under the ''item'' category and has the key ''exampleitem''.

The language file is read line by line in order. If one line is a category change, all the next keys will be under that category. Here's an example:
<syntaxhighlight lang="ini">
[mycategory]
mykey=Text
otherkey=Other text

[newcategory]
differentkey=Different text

[item]
exampleitem=Example item
</syntaxhighlight>
Translations can have replacements that can be done in runtime. To add a replacement key in your translation, add a <key> somewhere. The key can be anything like <name>, <number> etc. Example: <code>mobhealth=Mob health: <health></code>

==== Using a translation inside the game ====
<code>Localization.translate(category, key)</code>
<code>Localization.translate(category, key, replaceKey1, replaceString1, replaceKey2, replaceString2, ...)</code>

A lot of places also use the GameMessage class. This is essentially a localizable string, by using LocalMessage which extends GameMessage. Goes the same as above:
<code>new LocalMessage(category, key, replaceKey1, replaceString1, replaceKey2, replaceString2, ...)</code>

If you don't want to use a translation, you can also just give it a static string with <code>new StaticMessage(string...)</code>

=== Resources ===
For the game to load your resources, they have to be placed inside a resources folder in your mod jar.

Using this, it is also possible to overwrite existing ingame textures by placing another texture at the exact same path as the core game ones. In the Discord server, there is a wiki channel with a pinned message where the core textures can be downloaded and used for modding and this wiki.

This also means that your resource files can get overwritten by other mods, so try and keep your file names unique.

Resource loading happens automatically for any files in the resources folder. But some things will look at specific subfolders to load their textures. Examples:
* '''Items''' - items/<item stringiD>
* '''Buffs''' - buffs/<buff stringiD>
* '''Biomes''' - biomes/<biome stringiD>
* '''Projectiles''' - projectiles/<projectile stringiD>

== More documentation ==
Until more documentation gets migrated and added to this wiki, you can use the old documentation here: [https://docs.google.com/document/u/1/d/e/2PACX-1vTexy0ZwJmztm6KhvwUCpSbgdNFV5hxUOr_6rSiCyqvjlj80Sj28Alenodq6AbOfnKaWoj-zv0iziyL/pub Published Google docs file]
[[Modding Snippets]] Has examples of other modders coding work that can be used to help you out.

== Accessing Necesse Java files ==
[[File:Decompile1.png|thumb|Decompile1]]
[[File:Decompile2.png|thumb|Decompile2]]
[[File:Decompile3.png|thumb|Decompile3]]
[[File:Decompile4.png|thumb|Decompile4]]
using the IDE mentioned in [[Modding#Modding_tools|Modding Tools]], you can decompile java files and take a peek at the core game values. 
 

{{stub|reason = Need to reformat this section}} 
'''Note: Java may need to be installed for this process''' 
You probably need to have Java installed.(external links not allowed) 
Download and install the Windows x64 .msi file 

'''Rough Transcript from Discord User Snoobinoob, to be refined:''' 
Open up IntelliJ IDEA and create a new Java project wherever 
File > New > Project... 
Can leave all settings as is 
Once the project is created, open up the project structure 
File > Project Structure... (Ctrl+Alt+Shift+S) 
select "Modules" from the left navigaiton pane 
Click the dependencies tab on the top-right-ish (Decompile1) 
Click the + icon to add a new module and choose "JARs or Directories" (Decompile2) 
Browse to the steam files location of Necesse.jar 
Should be something like: C:\Program Files (x86)\Steam\steamapps\common\Necesse\Necesse.jar 
Should see this (or similar) after clicking the +, choosing JARs or Directories, and browsing to the Necesse.jar location (Decompile3) 
Click OK, and you should now see Necesse.jar in the list of dependencies in the previous Modules window 
Click OK again to close the project structure window 
Necesse.jar should now be visible in External Libraries (Decompile4) 
Everything should now be set up, so you can search via the Navigate > Search Everywhere menu option 
Exactly what to search is up to you, and not always the most obvious

Modding

2026-02-04T02:43:48Z

Jamesp1989: /* Mod info file */

Modding is the act of modifying, adding or removing content and features. Mods are created by the community, and shared through the [https://steamcommunity.com/app/1169040/workshop/ Steam Workshop]. They can be anything like adding more items and monsters, adding a new language, changing the textures in the game, adding new features, tweaking balance and much more.

Necesse mods are created using the Java programming language.

__TOC__

== Installing and using mods ==
=== Steam Workshop ===
Modders usually share their mods on the [https://steamcommunity.com/app/1169040/workshop/ Steam Workshop]. If you subscribe to a mod, the next time you launch the game a mods button will appear in the main menu. In this menu you can see the mods you have installed, change their load order, enable or disable them.
=== Dedicated servers and local mods ===
For dedicated servers to have mods, they must find and download the mod jar file. Many modders give links to where they can be downloaded on the mods Workshop page. Once you have the jar file, you have to put it inside a mods folder, depending on your system. 
If the folder does not exist on your system, you can create one yourself. 
'''Note: ONLY the jar file is needed for the mod to be active, the rest of the files within the example mod are for gradle tasks to help make testing easier''' 

* '''Windows:''' %APPDATA%/Necesse/mods/
* '''Linux:''' ~/.config/Necesse/mods
* '''Mac:''' ~/Library/Application Support/Necesse/mods/

* '''Windows dedicated Server over steamcmd '''

Install your server as usual with steamcmd with the AppID 1169370.

Create then in your server install directory a new folder mods
as example: c:\Servers\Necesse\mods

Then you have to edit the server start parameters (in startserver-nogui.bat)

default:
start jre\bin\java.exe -jar Server.jar -nogui %*

edit in:
start jre\bin\java.exe -jar Server.jar -nogui -datadir .\data -mod .\mods

Then copy your .jar mod files downloaded over the steam workshop as explained earlier in this thread into the mods folder. The server will recognize on startup the mods in the folder and loads them.

== Texture/Resource packs ==
Texture packs are not officially supported, except through the modding system. However, it is still possible to overwrite existing textures inside the game. To do so, follow the steps:

# Download the official textures, found on the [https://discord.gg/FAFgrKD Official Discord server], in a pinned message inside the wiki channel.
# Browse to the games install directory. You can do so by right-clicking the game in your Steam library -> Manage -> Browse local files.
# Extract the texture files into "<Necesse install directory>/res". If the "res" folder does not exist, you have to create it yourself.

The next time you launch the game, the textures will be loaded from those extracted files. This means you can edit or replace any of the files and that will then be loaded instead.

== Creating mods ==
Necesse mods are created using the Java programming language. This place is not for you to learn Java, there are plenty of tutorials and resources on that out on the internet already.

Mods are packaged inside a jar file for the game to load during runtime. When modding, it's a good idea to have a decompiler (included in most IDEs). The source code won't be released yet (if ever), and many topics are not explained thoroughly yet. This means you often have to rely on decompiling classes and checking out how they are done in the core game.

[https://discord.gg/FAFgrKD The Official Discord Server] has a channel dedicated to modding where you can ask questions, get help and request new modding features for the game and all other things Necesse modding.

=== New in v. 0.21.27 ===
''If you are just starting out modding, you can skip this section.'' 
In version 0.21.27 and forward, the game has changed the Java runtime environment it used. If you try to launch the game with the old runtime environment, you may run into crashes or other problems. You can download the runtime currently being used [https://adoptium.net/temurin/releases/?version=17 here]. To help with compatibility, the language level is still version 8. In IntelliJ, you can change your JDK and language level by going to File -> Project Structure... -> Project. Make sure that Gradle is also using the correct JDK by going to File -> Settings -> Build, Execution and Deployment -> Build Tools -> Gradle -> Gradle JVM. The example project has been updated to use this new Java and Gradle version.

=== Getting started and example project ===
To get started on modding, there is an '''[https://github.com/DrFair/ExampleMod official example project you can download, found on Github].''' It includes basic stuff like adding items, tiles, objects, monsters, recipes and more. It also includes build tools using Gradle to easily compile and structure your mod so that it can be read and loaded by the game, as well as development tools like loading your in-development mod, so that you can upload it to the Steam Workshop when complete.

=== Modding tools ===
* An integrated development environment (IDE). For example [https://www.jetbrains.com/idea/download Intellij IDEA Community] which is free.
* A Java development kit. The game is built using Adoptium Java17, which you can find [https://adoptium.net/temurin/releases/?version=17 here] but for compatibility reasons is still only using language level 8. If you are using the Intellij IDE, this is not needed as a JDK is already included in it. Make sure you are using language level 8 by going to File -> Project Structure... -> Language Level.
* An image editing tool, like pixel art editors [https://www.aseprite.org/ Aseprite] or [https://www.pyxeledit.com/ Pyxel Edit].
* An audio editing tool, like [https://www.audacityteam.org/ Audacity] or [https://www.reaper.fm/ REAPER].

=== Setting up ===
If you have downloaded the example project, it can be loaded using your IDE and almost everything will already be set up for you. All you have to do is configure your ''build.gradle'' file with the correct mod info and the games install directory. Once done, it will prompt you to refresh the project.

=== Running and testing your mod ===
[[File:Mod runClient Task.png|thumb|Image of where the gradle task can be found inside Intellij]]
To run your in-development mod, you will need to launch the game with ''-mod <folder path with your mod jar>'' option. This is already done for you if you are using the example project and run the ''runClient'' Gradle task. It can be found in the far-right toolbar inside Intellij (see image). Using this launch option will also allow you to upload your mod to Workshop once it is complete.

==== Testing multiplayer ====
To test multiplayer, you can run one client with the ''runClient'' Gradle task, and another with the ''runDevClient'' Gradle task. One client should host the game, while the other should connect through the multiplayer menu. The hosted game should show up as a LAN server, or you can manually connect to it by using "localhost" as IP the address. The dev client will load into the game with a different authentication ID, allowing you to have 2 clients inside the same server.

It's also important to test the dedicated server since it does not have access to the resources the clients load on startup. To do this, run the ''runServer'' Gradle task, and run your regular client at the same time. Same as above, you should then be able to see the game inside the multiplayer menu as a LAN server, or you can manually connect to it by using "localhost" as IP the address.

=== Mod info file ===
Note: If you are using the example mod, you can skip this section as it is generated for you using the values you set inside the ''build.gradle'' file.

Every mod must have a ''mod.info'' file in their jar's top path. The file structure is custom, but very similar to JSON. It's used throughout the game's saved files.
The file must have these fields:
* '''id''' - The unique ID of your mod. Must be all lowercase and cannot use special characters.
* '''name''' - The display name of your mod.
* '''version''' - The version of your mod.
* '''gameVersion''' - The target game version of your mod.
* '''description''' - A short description of your mod.
* '''author''' - Your name
* '''dependencies''' (optional) - Your mods dependencies are formatted in their IDs and array. Like this: [exammple.mod, other.mod]
* '''optionalDependecies''' (optional) - Your mods optional dependencies. They are used together with your dependencies to automatically make a load order for mods.
* '''clientside''' (optional) - true/false, if your mod is client/server-side only. This makes it possible for clients to connect to servers without the server needing the mod and vice versa. Defaults to false.

'''Important notes about your mod.info file:'''
# Your id should be unique to the mod and never change between versions. A good example for id is "<your name>.<mod name>".
# Avoid special characters that might inflict with the format, like commas, quotes, etc. This will probably be changed later, and you’ll be able to escape characters, just like in Java.

Example of a mod.info file:
<syntaxhighlight lang="ini">
{
id = fair.examplemod,
name = Example Mod,
version = 1.0,
gameVersion = 1.1.1,
description = Just an example mod,
author = Fair
}
</syntaxhighlight>

=== Mod entry class ===
Your mod needs an entry class. This is where the game loads your mod from and calls initialization methods. Create a class with the @ModEntry annotation to tell the game that's where your mod starts.

'''Important notes about your @ModEntry class:'''
# Make sure your mod only has one @ModEntry annotation. The game will stop looking for more when found one.
# Make sure the class does NOT have a constructor.

Example for your mod entry class:
<syntaxhighlight lang=Java>
import necesse.engine.modLoader.annotations.ModEntry;

@ModEntry
public class ExampleMod {

public void init() {
System.out.println("Hello world from my example mod!");
}

}
</syntaxhighlight>
The game will look for specific methods within your @ModEntry class. Here's a description of them:

==== public void preInit() ====
This method is called before loading of the core game. It should only be used on rare occasions. If you are not sure about it, don't use it.

==== public void init() ====
This method is called after the core game has been loaded. Here you should register your own tiles, objects, items, mobs and so on.

The general order in which you should register your mod objects to avoid issues are (not forced):
# Tiles
# Objects
# Biomes
# Buffs
# Global ingredients
# Recipe techs
# Items
# Enchantments
# Mobs
# Pickup entities and projectiles
# Level, world events, level data and settlers
# Containers
# World generators
# Packets
# Quests
# Other

==== public void initResources() ====
This method is called only on the client and should load any extra resources your mod uses that the game doesn't automatically load.

The resources will be loaded from a resource folder. You can read more about this in a later section.

Example: Assign a texture:

<code>GameTexture texture = GameTexture.fromFile("path/to/file")</code>

If you have a texture at resources/texture.png you can load it using <code>GameTexture.fromFile("texture")</code>

All sound (.ogg) files need to be placed in resources/sound folder and can be loaded using

<code>GameSound.fromFile("path/to/file")</code>

For example, a song placed in resources/sound/music/MySong.ogg would be loaded as <code>GameSound.fromFile("music/MySong")</code>, ommiting resources/sound

For information on music paths to override music, look at <code>MusicRegistry.registerCore</code>

==== public void postInit() ====
This method is called after the game is done loading all its core, mods and resources.

This is where you should register recipes, create or modify loot tables and spawn tables and register chat commands.

==== public void dispose() ====
This method is called when the game closes. If you have anything that needs to be disposed, that the game doesn't already dispose on it's own, do it here.

Things like textured loaded using <code>GameTexture.fromFile(...)</code> and sounds are automatically disposed.

=== Building your mod ===
If you are using the example project, a lot of this is already done for you. Simply run the ''buildModJar'' Gradle task, and it will generate the jar inside the ./build/jar folder.

For the game to recognize your jar, it has to follow a specific structure:
;ExampleMod.jar
: ↳ resources
:: ↳ Your resource files
: ↳ Java class files
: ↳ mod.info file

=== Uploading your mod ===
[[File:Upload mod.png|thumb|Image of the upload button when mod is loaded from development]]
To upload your mod to the Steam workshop, a few conditions have to be met:
* Must be enabled
* Must have a preview.png file in the resources folder
* Must be loaded through the -mod launch option (this is done automatically in the example project when running the ''runClient'' Gradle task. You can find more info about this under the beginning of the setting up section).
When all of these conditions are met, a button to upload your mod will appear when you select it inside the main menu mods screen. Click this and it will walk you through uploading to workshop. When you first upload, the mod will be hidden and only you will be able to see it. You can change this when you are ready to launch on your mods workshop page.

=== Localization ===
Localization files are needed to give your tiles, objects, items, mobs and other things names. The files should be placed inside the resources/locale folder, and be named the same as the language they are using. Example: en.lang for the english translation.

You can also see how the localization file is structured inside the example mod project.

==== The file structure ====
The file is divided up into categories and keys. If your item has the localization ''item.exampleitem'', it means that it's under the ''item'' category and has the key ''exampleitem''.

The language file is read line by line in order. If one line is a category change, all the next keys will be under that category. Here's an example:
<syntaxhighlight lang="ini">
[mycategory]
mykey=Text
otherkey=Other text

[newcategory]
differentkey=Different text

[item]
exampleitem=Example item
</syntaxhighlight>
Translations can have replacements that can be done in runtime. To add a replacement key in your translation, add a <key> somewhere. The key can be anything like <name>, <number> etc. Example: <code>mobhealth=Mob health: <health></code>

==== Using a translation inside the game ====
<code>Localization.translate(category, key)</code>
<code>Localization.translate(category, key, replaceKey1, replaceString1, replaceKey2, replaceString2, ...)</code>

A lot of places also use the GameMessage class. This is essentially a localizable string, by using LocalMessage which extends GameMessage. Goes the same as above:
<code>new LocalMessage(category, key, replaceKey1, replaceString1, replaceKey2, replaceString2, ...)</code>

If you don't want to use a translation, you can also just give it a static string with <code>new StaticMessage(string...)</code>

=== Resources ===
For the game to load your resources, they have to be placed inside a resources folder in your mod jar.

Using this, it is also possible to overwrite existing ingame textures by placing another texture at the exact same path as the core game ones. In the Discord server, there is a wiki channel with a pinned message where the core textures can be downloaded and used for modding and this wiki.

This also means that your resource files can get overwritten by other mods, so try and keep your file names unique.

Resource loading happens automatically for any files in the resources folder. But some things will look at specific subfolders to load their textures. Examples:
* '''Items''' - items/<item stringiD>
* '''Buffs''' - buffs/<buff stringiD>
* '''Biomes''' - biomes/<biome stringiD>
* '''Projectiles''' - projectiles/<projectile stringiD>

== More documentation ==
Until more documentation gets migrated and added to this wiki, you can use the old documentation here: [https://docs.google.com/document/u/1/d/e/2PACX-1vTexy0ZwJmztm6KhvwUCpSbgdNFV5hxUOr_6rSiCyqvjlj80Sj28Alenodq6AbOfnKaWoj-zv0iziyL/pub Published Google docs file]
[[Modding Snippets]] Has examples of other modders coding work that can be used to help you out.

== Accessing Necesse Java files ==
[[File:Decompile1.png|thumb|Decompile1]]
[[File:Decompile2.png|thumb|Decompile2]]
[[File:Decompile3.png|thumb|Decompile3]]
[[File:Decompile4.png|thumb|Decompile4]]
using the IDE mentioned in [[Modding#Modding_tools|Modding Tools]], you can decompile java files and take a peek at the core game values. 
 

{{stub|reason = Need to reformat this section}} 
'''Note: Java may need to be installed for this process''' 
You probably need to have Java installed.(external links not allowed) 
Download and install the Windows x64 .msi file 

'''Rough Transcript from Discord User Snoobinoob, to be refined:''' 
Open up IntelliJ IDEA and create a new Java project wherever 
File > New > Project... 
Can leave all settings as is 
Once the project is created, open up the project structure 
File > Project Structure... (Ctrl+Alt+Shift+S) 
select "Modules" from the left navigaiton pane 
Click the dependencies tab on the top-right-ish (Decompile1) 
Click the + icon to add a new module and choose "JARs or Directories" (Decompile2) 
Browse to the steam files location of Necesse.jar 
Should be something like: C:\Program Files (x86)\Steam\steamapps\common\Necesse\Necesse.jar 
Should see this (or similar) after clicking the +, choosing JARs or Directories, and browsing to the Necesse.jar location (Decompile3) 
Click OK, and you should now see Necesse.jar in the list of dependencies in the previous Modules window 
Click OK again to close the project structure window 
Necesse.jar should now be visible in External Libraries (Decompile4) 
Everything should now be set up, so you can search via the Navigate > Search Everywhere menu option 
Exactly what to search is up to you, and not always the most obvious

Modding

2026-02-04T02:42:55Z

Jamesp1989: moved over to syntax highlighting

Modding is the act of modifying, adding or removing content and features. Mods are created by the community, and shared through the [https://steamcommunity.com/app/1169040/workshop/ Steam Workshop]. They can be anything like adding more items and monsters, adding a new language, changing the textures in the game, adding new features, tweaking balance and much more.

Necesse mods are created using the Java programming language.

__TOC__

== Installing and using mods ==
=== Steam Workshop ===
Modders usually share their mods on the [https://steamcommunity.com/app/1169040/workshop/ Steam Workshop]. If you subscribe to a mod, the next time you launch the game a mods button will appear in the main menu. In this menu you can see the mods you have installed, change their load order, enable or disable them.
=== Dedicated servers and local mods ===
For dedicated servers to have mods, they must find and download the mod jar file. Many modders give links to where they can be downloaded on the mods Workshop page. Once you have the jar file, you have to put it inside a mods folder, depending on your system. 
If the folder does not exist on your system, you can create one yourself. 
'''Note: ONLY the jar file is needed for the mod to be active, the rest of the files within the example mod are for gradle tasks to help make testing easier''' 

* '''Windows:''' %APPDATA%/Necesse/mods/
* '''Linux:''' ~/.config/Necesse/mods
* '''Mac:''' ~/Library/Application Support/Necesse/mods/

* '''Windows dedicated Server over steamcmd '''

Install your server as usual with steamcmd with the AppID 1169370.

Create then in your server install directory a new folder mods
as example: c:\Servers\Necesse\mods

Then you have to edit the server start parameters (in startserver-nogui.bat)

default:
start jre\bin\java.exe -jar Server.jar -nogui %*

edit in:
start jre\bin\java.exe -jar Server.jar -nogui -datadir .\data -mod .\mods

Then copy your .jar mod files downloaded over the steam workshop as explained earlier in this thread into the mods folder. The server will recognize on startup the mods in the folder and loads them.

== Texture/Resource packs ==
Texture packs are not officially supported, except through the modding system. However, it is still possible to overwrite existing textures inside the game. To do so, follow the steps:

# Download the official textures, found on the [https://discord.gg/FAFgrKD Official Discord server], in a pinned message inside the wiki channel.
# Browse to the games install directory. You can do so by right-clicking the game in your Steam library -> Manage -> Browse local files.
# Extract the texture files into "<Necesse install directory>/res". If the "res" folder does not exist, you have to create it yourself.

The next time you launch the game, the textures will be loaded from those extracted files. This means you can edit or replace any of the files and that will then be loaded instead.

== Creating mods ==
Necesse mods are created using the Java programming language. This place is not for you to learn Java, there are plenty of tutorials and resources on that out on the internet already.

Mods are packaged inside a jar file for the game to load during runtime. When modding, it's a good idea to have a decompiler (included in most IDEs). The source code won't be released yet (if ever), and many topics are not explained thoroughly yet. This means you often have to rely on decompiling classes and checking out how they are done in the core game.

[https://discord.gg/FAFgrKD The Official Discord Server] has a channel dedicated to modding where you can ask questions, get help and request new modding features for the game and all other things Necesse modding.

=== New in v. 0.21.27 ===
''If you are just starting out modding, you can skip this section.'' 
In version 0.21.27 and forward, the game has changed the Java runtime environment it used. If you try to launch the game with the old runtime environment, you may run into crashes or other problems. You can download the runtime currently being used [https://adoptium.net/temurin/releases/?version=17 here]. To help with compatibility, the language level is still version 8. In IntelliJ, you can change your JDK and language level by going to File -> Project Structure... -> Project. Make sure that Gradle is also using the correct JDK by going to File -> Settings -> Build, Execution and Deployment -> Build Tools -> Gradle -> Gradle JVM. The example project has been updated to use this new Java and Gradle version.

=== Getting started and example project ===
To get started on modding, there is an '''[https://github.com/DrFair/ExampleMod official example project you can download, found on Github].''' It includes basic stuff like adding items, tiles, objects, monsters, recipes and more. It also includes build tools using Gradle to easily compile and structure your mod so that it can be read and loaded by the game, as well as development tools like loading your in-development mod, so that you can upload it to the Steam Workshop when complete.

=== Modding tools ===
* An integrated development environment (IDE). For example [https://www.jetbrains.com/idea/download Intellij IDEA Community] which is free.
* A Java development kit. The game is built using Adoptium Java17, which you can find [https://adoptium.net/temurin/releases/?version=17 here] but for compatibility reasons is still only using language level 8. If you are using the Intellij IDE, this is not needed as a JDK is already included in it. Make sure you are using language level 8 by going to File -> Project Structure... -> Language Level.
* An image editing tool, like pixel art editors [https://www.aseprite.org/ Aseprite] or [https://www.pyxeledit.com/ Pyxel Edit].
* An audio editing tool, like [https://www.audacityteam.org/ Audacity] or [https://www.reaper.fm/ REAPER].

=== Setting up ===
If you have downloaded the example project, it can be loaded using your IDE and almost everything will already be set up for you. All you have to do is configure your ''build.gradle'' file with the correct mod info and the games install directory. Once done, it will prompt you to refresh the project.

=== Running and testing your mod ===
[[File:Mod runClient Task.png|thumb|Image of where the gradle task can be found inside Intellij]]
To run your in-development mod, you will need to launch the game with ''-mod <folder path with your mod jar>'' option. This is already done for you if you are using the example project and run the ''runClient'' Gradle task. It can be found in the far-right toolbar inside Intellij (see image). Using this launch option will also allow you to upload your mod to Workshop once it is complete.

==== Testing multiplayer ====
To test multiplayer, you can run one client with the ''runClient'' Gradle task, and another with the ''runDevClient'' Gradle task. One client should host the game, while the other should connect through the multiplayer menu. The hosted game should show up as a LAN server, or you can manually connect to it by using "localhost" as IP the address. The dev client will load into the game with a different authentication ID, allowing you to have 2 clients inside the same server.

It's also important to test the dedicated server since it does not have access to the resources the clients load on startup. To do this, run the ''runServer'' Gradle task, and run your regular client at the same time. Same as above, you should then be able to see the game inside the multiplayer menu as a LAN server, or you can manually connect to it by using "localhost" as IP the address.

=== Mod info file ===
Note: If you are using the example mod, you can skip this section as it is generated for you using the values you set inside the ''build.gradle'' file.

Every mod must have a ''mod.info'' file in their jar's top path. The file structure is custom, but very similar to JSON. It's used throughout the game's saved files.
The file must have these fields:
* '''id''' - The unique ID of your mod. Must be all lowercase and cannot use special characters.
* '''name''' - The display name of your mod.
* '''version''' - The version of your mod.
* '''gameVersion''' - The target game version of your mod.
* '''description''' - A short description of your mod.
* '''author''' - Your name
* '''dependencies''' (optional) - Your mods dependencies are formatted in their IDs and array. Like this: [exammple.mod, other.mod]
* '''optionalDependecies''' (optional) - Your mods optional dependencies. They are used together with your dependencies to automatically make a load order for mods.
* '''clientside''' (optional) - true/false, if your mod is client/server-side only. This makes it possible for clients to connect to servers without the server needing the mod and vice versa. Defaults to false.

'''Important notes about your mod.info file:'''
# Your id should be unique to the mod and never change between versions. A good example for id is "<your name>.<mod name>".
# Avoid special characters that might inflict with the format, like commas, quotes, etc. This will probably be changed later, and you’ll be able to escape characters, just like in Java.

Example of a mod.info file:
<pre>
{
id = fair.examplemod,
name = Example Mod,
version = 1.0,
gameVersion = 1.1.1,
description = Just an example mod,
author = Fair
}
</pre>

=== Mod entry class ===
Your mod needs an entry class. This is where the game loads your mod from and calls initialization methods. Create a class with the @ModEntry annotation to tell the game that's where your mod starts.

'''Important notes about your @ModEntry class:'''
# Make sure your mod only has one @ModEntry annotation. The game will stop looking for more when found one.
# Make sure the class does NOT have a constructor.

Example for your mod entry class:
<syntaxhighlight lang=Java>
import necesse.engine.modLoader.annotations.ModEntry;

@ModEntry
public class ExampleMod {

public void init() {
System.out.println("Hello world from my example mod!");
}

}
</syntaxhighlight>
The game will look for specific methods within your @ModEntry class. Here's a description of them:

==== public void preInit() ====
This method is called before loading of the core game. It should only be used on rare occasions. If you are not sure about it, don't use it.

==== public void init() ====
This method is called after the core game has been loaded. Here you should register your own tiles, objects, items, mobs and so on.

The general order in which you should register your mod objects to avoid issues are (not forced):
# Tiles
# Objects
# Biomes
# Buffs
# Global ingredients
# Recipe techs
# Items
# Enchantments
# Mobs
# Pickup entities and projectiles
# Level, world events, level data and settlers
# Containers
# World generators
# Packets
# Quests
# Other

==== public void initResources() ====
This method is called only on the client and should load any extra resources your mod uses that the game doesn't automatically load.

The resources will be loaded from a resource folder. You can read more about this in a later section.

Example: Assign a texture:

<code>GameTexture texture = GameTexture.fromFile("path/to/file")</code>

If you have a texture at resources/texture.png you can load it using <code>GameTexture.fromFile("texture")</code>

All sound (.ogg) files need to be placed in resources/sound folder and can be loaded using

<code>GameSound.fromFile("path/to/file")</code>

For example, a song placed in resources/sound/music/MySong.ogg would be loaded as <code>GameSound.fromFile("music/MySong")</code>, ommiting resources/sound

For information on music paths to override music, look at <code>MusicRegistry.registerCore</code>

==== public void postInit() ====
This method is called after the game is done loading all its core, mods and resources.

This is where you should register recipes, create or modify loot tables and spawn tables and register chat commands.

==== public void dispose() ====
This method is called when the game closes. If you have anything that needs to be disposed, that the game doesn't already dispose on it's own, do it here.

Things like textured loaded using <code>GameTexture.fromFile(...)</code> and sounds are automatically disposed.

=== Building your mod ===
If you are using the example project, a lot of this is already done for you. Simply run the ''buildModJar'' Gradle task, and it will generate the jar inside the ./build/jar folder.

For the game to recognize your jar, it has to follow a specific structure:
;ExampleMod.jar
: ↳ resources
:: ↳ Your resource files
: ↳ Java class files
: ↳ mod.info file

=== Uploading your mod ===
[[File:Upload mod.png|thumb|Image of the upload button when mod is loaded from development]]
To upload your mod to the Steam workshop, a few conditions have to be met:
* Must be enabled
* Must have a preview.png file in the resources folder
* Must be loaded through the -mod launch option (this is done automatically in the example project when running the ''runClient'' Gradle task. You can find more info about this under the beginning of the setting up section).
When all of these conditions are met, a button to upload your mod will appear when you select it inside the main menu mods screen. Click this and it will walk you through uploading to workshop. When you first upload, the mod will be hidden and only you will be able to see it. You can change this when you are ready to launch on your mods workshop page.

=== Localization ===
Localization files are needed to give your tiles, objects, items, mobs and other things names. The files should be placed inside the resources/locale folder, and be named the same as the language they are using. Example: en.lang for the english translation.

You can also see how the localization file is structured inside the example mod project.

==== The file structure ====
The file is divided up into categories and keys. If your item has the localization ''item.exampleitem'', it means that it's under the ''item'' category and has the key ''exampleitem''.

The language file is read line by line in order. If one line is a category change, all the next keys will be under that category. Here's an example:
<syntaxhighlight lang="ini">
[mycategory]
mykey=Text
otherkey=Other text

[newcategory]
differentkey=Different text

[item]
exampleitem=Example item
</syntaxhighlight>
Translations can have replacements that can be done in runtime. To add a replacement key in your translation, add a <key> somewhere. The key can be anything like <name>, <number> etc. Example: <code>mobhealth=Mob health: <health></code>

==== Using a translation inside the game ====
<code>Localization.translate(category, key)</code>
<code>Localization.translate(category, key, replaceKey1, replaceString1, replaceKey2, replaceString2, ...)</code>

A lot of places also use the GameMessage class. This is essentially a localizable string, by using LocalMessage which extends GameMessage. Goes the same as above:
<code>new LocalMessage(category, key, replaceKey1, replaceString1, replaceKey2, replaceString2, ...)</code>

If you don't want to use a translation, you can also just give it a static string with <code>new StaticMessage(string...)</code>

=== Resources ===
For the game to load your resources, they have to be placed inside a resources folder in your mod jar.

Using this, it is also possible to overwrite existing ingame textures by placing another texture at the exact same path as the core game ones. In the Discord server, there is a wiki channel with a pinned message where the core textures can be downloaded and used for modding and this wiki.

This also means that your resource files can get overwritten by other mods, so try and keep your file names unique.

Resource loading happens automatically for any files in the resources folder. But some things will look at specific subfolders to load their textures. Examples:
* '''Items''' - items/<item stringiD>
* '''Buffs''' - buffs/<buff stringiD>
* '''Biomes''' - biomes/<biome stringiD>
* '''Projectiles''' - projectiles/<projectile stringiD>

== More documentation ==
Until more documentation gets migrated and added to this wiki, you can use the old documentation here: [https://docs.google.com/document/u/1/d/e/2PACX-1vTexy0ZwJmztm6KhvwUCpSbgdNFV5hxUOr_6rSiCyqvjlj80Sj28Alenodq6AbOfnKaWoj-zv0iziyL/pub Published Google docs file]
[[Modding Snippets]] Has examples of other modders coding work that can be used to help you out.

== Accessing Necesse Java files ==
[[File:Decompile1.png|thumb|Decompile1]]
[[File:Decompile2.png|thumb|Decompile2]]
[[File:Decompile3.png|thumb|Decompile3]]
[[File:Decompile4.png|thumb|Decompile4]]
using the IDE mentioned in [[Modding#Modding_tools|Modding Tools]], you can decompile java files and take a peek at the core game values. 
 

{{stub|reason = Need to reformat this section}} 
'''Note: Java may need to be installed for this process''' 
You probably need to have Java installed.(external links not allowed) 
Download and install the Windows x64 .msi file 

'''Rough Transcript from Discord User Snoobinoob, to be refined:''' 
Open up IntelliJ IDEA and create a new Java project wherever 
File > New > Project... 
Can leave all settings as is 
Once the project is created, open up the project structure 
File > Project Structure... (Ctrl+Alt+Shift+S) 
select "Modules" from the left navigaiton pane 
Click the dependencies tab on the top-right-ish (Decompile1) 
Click the + icon to add a new module and choose "JARs or Directories" (Decompile2) 
Browse to the steam files location of Necesse.jar 
Should be something like: C:\Program Files (x86)\Steam\steamapps\common\Necesse\Necesse.jar 
Should see this (or similar) after clicking the +, choosing JARs or Directories, and browsing to the Necesse.jar location (Decompile3) 
Click OK, and you should now see Necesse.jar in the list of dependencies in the previous Modules window 
Click OK again to close the project structure window 
Necesse.jar should now be visible in External Libraries (Decompile4) 
Everything should now be set up, so you can search via the Navigate > Search Everywhere menu option 
Exactly what to search is up to you, and not always the most obvious

Modding

2026-02-04T02:35:59Z

Jamesp1989: Moved the code block to actually use our shiny (now working syntax highlighter thanks @fair)

Modding is the act of modifying, adding or removing content and features. Mods are created by the community, and shared through the [https://steamcommunity.com/app/1169040/workshop/ Steam Workshop]. They can be anything like adding more items and monsters, adding a new language, changing the textures in the game, adding new features, tweaking balance and much more.

Necesse mods are created using the Java programming language.

__TOC__

== Installing and using mods ==
=== Steam Workshop ===
Modders usually share their mods on the [https://steamcommunity.com/app/1169040/workshop/ Steam Workshop]. If you subscribe to a mod, the next time you launch the game a mods button will appear in the main menu. In this menu you can see the mods you have installed, change their load order, enable or disable them.
=== Dedicated servers and local mods ===
For dedicated servers to have mods, they must find and download the mod jar file. Many modders give links to where they can be downloaded on the mods Workshop page. Once you have the jar file, you have to put it inside a mods folder, depending on your system. 
If the folder does not exist on your system, you can create one yourself. 
'''Note: ONLY the jar file is needed for the mod to be active, the rest of the files within the example mod are for gradle tasks to help make testing easier''' 

* '''Windows:''' %APPDATA%/Necesse/mods/
* '''Linux:''' ~/.config/Necesse/mods
* '''Mac:''' ~/Library/Application Support/Necesse/mods/

* '''Windows dedicated Server over steamcmd '''

Install your server as usual with steamcmd with the AppID 1169370.

Create then in your server install directory a new folder mods
as example: c:\Servers\Necesse\mods

Then you have to edit the server start parameters (in startserver-nogui.bat)

default:
start jre\bin\java.exe -jar Server.jar -nogui %*

edit in:
start jre\bin\java.exe -jar Server.jar -nogui -datadir .\data -mod .\mods

Then copy your .jar mod files downloaded over the steam workshop as explained earlier in this thread into the mods folder. The server will recognize on startup the mods in the folder and loads them.

== Texture/Resource packs ==
Texture packs are not officially supported, except through the modding system. However, it is still possible to overwrite existing textures inside the game. To do so, follow the steps:

# Download the official textures, found on the [https://discord.gg/FAFgrKD Official Discord server], in a pinned message inside the wiki channel.
# Browse to the games install directory. You can do so by right-clicking the game in your Steam library -> Manage -> Browse local files.
# Extract the texture files into "<Necesse install directory>/res". If the "res" folder does not exist, you have to create it yourself.

The next time you launch the game, the textures will be loaded from those extracted files. This means you can edit or replace any of the files and that will then be loaded instead.

== Creating mods ==
Necesse mods are created using the Java programming language. This place is not for you to learn Java, there are plenty of tutorials and resources on that out on the internet already.

Mods are packaged inside a jar file for the game to load during runtime. When modding, it's a good idea to have a decompiler (included in most IDEs). The source code won't be released yet (if ever), and many topics are not explained thoroughly yet. This means you often have to rely on decompiling classes and checking out how they are done in the core game.

[https://discord.gg/FAFgrKD The Official Discord Server] has a channel dedicated to modding where you can ask questions, get help and request new modding features for the game and all other things Necesse modding.

=== New in v. 0.21.27 ===
''If you are just starting out modding, you can skip this section.'' 
In version 0.21.27 and forward, the game has changed the Java runtime environment it used. If you try to launch the game with the old runtime environment, you may run into crashes or other problems. You can download the runtime currently being used [https://adoptium.net/temurin/releases/?version=17 here]. To help with compatibility, the language level is still version 8. In IntelliJ, you can change your JDK and language level by going to File -> Project Structure... -> Project. Make sure that Gradle is also using the correct JDK by going to File -> Settings -> Build, Execution and Deployment -> Build Tools -> Gradle -> Gradle JVM. The example project has been updated to use this new Java and Gradle version.

=== Getting started and example project ===
To get started on modding, there is an '''[https://github.com/DrFair/ExampleMod official example project you can download, found on Github].''' It includes basic stuff like adding items, tiles, objects, monsters, recipes and more. It also includes build tools using Gradle to easily compile and structure your mod so that it can be read and loaded by the game, as well as development tools like loading your in-development mod, so that you can upload it to the Steam Workshop when complete.

=== Modding tools ===
* An integrated development environment (IDE). For example [https://www.jetbrains.com/idea/download Intellij IDEA Community] which is free.
* A Java development kit. The game is built using Adoptium Java17, which you can find [https://adoptium.net/temurin/releases/?version=17 here] but for compatibility reasons is still only using language level 8. If you are using the Intellij IDE, this is not needed as a JDK is already included in it. Make sure you are using language level 8 by going to File -> Project Structure... -> Language Level.
* An image editing tool, like pixel art editors [https://www.aseprite.org/ Aseprite] or [https://www.pyxeledit.com/ Pyxel Edit].
* An audio editing tool, like [https://www.audacityteam.org/ Audacity] or [https://www.reaper.fm/ REAPER].

=== Setting up ===
If you have downloaded the example project, it can be loaded using your IDE and almost everything will already be set up for you. All you have to do is configure your ''build.gradle'' file with the correct mod info and the games install directory. Once done, it will prompt you to refresh the project.

=== Running and testing your mod ===
[[File:Mod runClient Task.png|thumb|Image of where the gradle task can be found inside Intellij]]
To run your in-development mod, you will need to launch the game with ''-mod <folder path with your mod jar>'' option. This is already done for you if you are using the example project and run the ''runClient'' Gradle task. It can be found in the far-right toolbar inside Intellij (see image). Using this launch option will also allow you to upload your mod to Workshop once it is complete.

==== Testing multiplayer ====
To test multiplayer, you can run one client with the ''runClient'' Gradle task, and another with the ''runDevClient'' Gradle task. One client should host the game, while the other should connect through the multiplayer menu. The hosted game should show up as a LAN server, or you can manually connect to it by using "localhost" as IP the address. The dev client will load into the game with a different authentication ID, allowing you to have 2 clients inside the same server.

It's also important to test the dedicated server since it does not have access to the resources the clients load on startup. To do this, run the ''runServer'' Gradle task, and run your regular client at the same time. Same as above, you should then be able to see the game inside the multiplayer menu as a LAN server, or you can manually connect to it by using "localhost" as IP the address.

=== Mod info file ===
Note: If you are using the example mod, you can skip this section as it is generated for you using the values you set inside the ''build.gradle'' file.

Every mod must have a ''mod.info'' file in their jar's top path. The file structure is custom, but very similar to JSON. It's used throughout the game's saved files.
The file must have these fields:
* '''id''' - The unique ID of your mod. Must be all lowercase and cannot use special characters.
* '''name''' - The display name of your mod.
* '''version''' - The version of your mod.
* '''gameVersion''' - The target game version of your mod.
* '''description''' - A short description of your mod.
* '''author''' - Your name
* '''dependencies''' (optional) - Your mods dependencies are formatted in their IDs and array. Like this: [exammple.mod, other.mod]
* '''optionalDependecies''' (optional) - Your mods optional dependencies. They are used together with your dependencies to automatically make a load order for mods.
* '''clientside''' (optional) - true/false, if your mod is client/server-side only. This makes it possible for clients to connect to servers without the server needing the mod and vice versa. Defaults to false.

'''Important notes about your mod.info file:'''
# Your id should be unique to the mod and never change between versions. A good example for id is "<your name>.<mod name>".
# Avoid special characters that might inflict with the format, like commas, quotes, etc. This will probably be changed later, and you’ll be able to escape characters, just like in Java.

Example of a mod.info file:
<pre>
{
id = fair.examplemod,
name = Example Mod,
version = 1.0,
gameVersion = 1.1.1,
description = Just an example mod,
author = Fair
}
</pre>

=== Mod entry class ===
Your mod needs an entry class. This is where the game loads your mod from and calls initialization methods. Create a class with the @ModEntry annotation to tell the game that's where your mod starts.

'''Important notes about your @ModEntry class:'''
# Make sure your mod only has one @ModEntry annotation. The game will stop looking for more when found one.
# Make sure the class does NOT have a constructor.

Example for your mod entry class:
<syntaxhighlight lang=Java>
import necesse.engine.modLoader.annotations.ModEntry;

@ModEntry
public class ExampleMod {

public void init() {
System.out.println("Hello world from my example mod!");
}

}
</syntaxhighlight>
The game will look for specific methods within your @ModEntry class. Here's a description of them:

==== public void preInit() ====
This method is called before loading of the core game. It should only be used on rare occasions. If you are not sure about it, don't use it.

==== public void init() ====
This method is called after the core game has been loaded. Here you should register your own tiles, objects, items, mobs and so on.

The general order in which you should register your mod objects to avoid issues are (not forced):
# Tiles
# Objects
# Biomes
# Buffs
# Global ingredients
# Recipe techs
# Items
# Enchantments
# Mobs
# Pickup entities and projectiles
# Level, world events, level data and settlers
# Containers
# World generators
# Packets
# Quests
# Other

==== public void initResources() ====
This method is called only on the client and should load any extra resources your mod uses that the game doesn't automatically load.

The resources will be loaded from a resource folder. You can read more about this in a later section.

Example: Assign a texture:

<code>GameTexture texture = GameTexture.fromFile("path/to/file")</code>

If you have a texture at resources/texture.png you can load it using <code>GameTexture.fromFile("texture")</code>

All sound (.ogg) files need to be placed in resources/sound folder and can be loaded using

<code>GameSound.fromFile("path/to/file")</code>

For example, a song placed in resources/sound/music/MySong.ogg would be loaded as <code>GameSound.fromFile("music/MySong")</code>, ommiting resources/sound

For information on music paths to override music, look at <code>MusicRegistry.registerCore</code>

==== public void postInit() ====
This method is called after the game is done loading all its core, mods and resources.

This is where you should register recipes, create or modify loot tables and spawn tables and register chat commands.

==== public void dispose() ====
This method is called when the game closes. If you have anything that needs to be disposed, that the game doesn't already dispose on it's own, do it here.

Things like textured loaded using <code>GameTexture.fromFile(...)</code> and sounds are automatically disposed.

=== Building your mod ===
If you are using the example project, a lot of this is already done for you. Simply run the ''buildModJar'' Gradle task, and it will generate the jar inside the ./build/jar folder.

For the game to recognize your jar, it has to follow a specific structure:
;ExampleMod.jar
: ↳ resources
:: ↳ Your resource files
: ↳ Java class files
: ↳ mod.info file

=== Uploading your mod ===
[[File:Upload mod.png|thumb|Image of the upload button when mod is loaded from development]]
To upload your mod to the Steam workshop, a few conditions have to be met:
* Must be enabled
* Must have a preview.png file in the resources folder
* Must be loaded through the -mod launch option (this is done automatically in the example project when running the ''runClient'' Gradle task. You can find more info about this under the beginning of the setting up section).
When all of these conditions are met, a button to upload your mod will appear when you select it inside the main menu mods screen. Click this and it will walk you through uploading to workshop. When you first upload, the mod will be hidden and only you will be able to see it. You can change this when you are ready to launch on your mods workshop page.

=== Localization ===
Localization files are needed to give your tiles, objects, items, mobs and other things names. The files should be placed inside the resources/locale folder, and be named the same as the language they are using. Example: en.lang for the english translation.

You can also see how the localization file is structured inside the example mod project.

==== The file structure ====
The file is divided up into categories and keys. If your item has the localization ''item.exampleitem'', it means that it's under the ''item'' category and has the key ''exampleitem''.

The language file is read line by line in order. If one line is a category change, all the next keys will be under that category. Here's an example:
<pre>
[mycategory]
mykey=Text
otherkey=Other text

[newcategory]
differentkey=Different text

[item]
exampleitem=Example item
</pre>
Translations can have replacements that can be done in runtime. To add a replacement key in your translation, add a <key> somewhere. The key can be anything like <name>, <number> etc. Example: <code>mobhealth=Mob health: <health></code>

==== Using a translation inside the game ====
<code>Localization.translate(category, key)</code>
<code>Localization.translate(category, key, replaceKey1, replaceString1, replaceKey2, replaceString2, ...)</code>

A lot of places also use the GameMessage class. This is essentially a localizable string, by using LocalMessage which extends GameMessage. Goes the same as above:
<code>new LocalMessage(category, key, replaceKey1, replaceString1, replaceKey2, replaceString2, ...)</code>

If you don't want to use a translation, you can also just give it a static string with <code>new StaticMessage(string...)</code>

=== Resources ===
For the game to load your resources, they have to be placed inside a resources folder in your mod jar.

Using this, it is also possible to overwrite existing ingame textures by placing another texture at the exact same path as the core game ones. In the Discord server, there is a wiki channel with a pinned message where the core textures can be downloaded and used for modding and this wiki.

This also means that your resource files can get overwritten by other mods, so try and keep your file names unique.

Resource loading happens automatically for any files in the resources folder. But some things will look at specific subfolders to load their textures. Examples:
* '''Items''' - items/<item stringiD>
* '''Buffs''' - buffs/<buff stringiD>
* '''Biomes''' - biomes/<biome stringiD>
* '''Projectiles''' - projectiles/<projectile stringiD>

== More documentation ==
Until more documentation gets migrated and added to this wiki, you can use the old documentation here: [https://docs.google.com/document/u/1/d/e/2PACX-1vTexy0ZwJmztm6KhvwUCpSbgdNFV5hxUOr_6rSiCyqvjlj80Sj28Alenodq6AbOfnKaWoj-zv0iziyL/pub Published Google docs file]
[[Modding Snippets]] Has examples of other modders coding work that can be used to help you out.

== Accessing Necesse Java files ==
[[File:Decompile1.png|thumb|Decompile1]]
[[File:Decompile2.png|thumb|Decompile2]]
[[File:Decompile3.png|thumb|Decompile3]]
[[File:Decompile4.png|thumb|Decompile4]]
using the IDE mentioned in [[Modding#Modding_tools|Modding Tools]], you can decompile java files and take a peek at the core game values. 
 

{{stub|reason = Need to reformat this section}} 
'''Note: Java may need to be installed for this process''' 
You probably need to have Java installed.(external links not allowed) 
Download and install the Windows x64 .msi file 

'''Rough Transcript from Discord User Snoobinoob, to be refined:''' 
Open up IntelliJ IDEA and create a new Java project wherever 
File > New > Project... 
Can leave all settings as is 
Once the project is created, open up the project structure 
File > Project Structure... (Ctrl+Alt+Shift+S) 
select "Modules" from the left navigaiton pane 
Click the dependencies tab on the top-right-ish (Decompile1) 
Click the + icon to add a new module and choose "JARs or Directories" (Decompile2) 
Browse to the steam files location of Necesse.jar 
Should be something like: C:\Program Files (x86)\Steam\steamapps\common\Necesse\Necesse.jar 
Should see this (or similar) after clicking the +, choosing JARs or Directories, and browsing to the Necesse.jar location (Decompile3) 
Click OK, and you should now see Necesse.jar in the list of dependencies in the previous Modules window 
Click OK again to close the project structure window 
Necesse.jar should now be visible in External Libraries (Decompile4) 
Everything should now be set up, so you can search via the Navigate > Search Everywhere menu option 
Exactly what to search is up to you, and not always the most obvious

Cactus

2026-01-20T22:26:50Z

Jamesp1989:

{{Infobox item
|stringID = {{FULLPAGENAME}}
|name = {{FULLPAGENAME}}
|image = {{FULLPAGENAME}}.png
|type = [[Saplings]]
|type2 = [[Other Plants]]
}}

[[{{FULLPAGENAME}}]] is a sapling that can be obtained by cutting [[Other Plants|cactuses]] in [[Desert Biome]] 

[[{{FULLPAGENAME}}]] can be planted on [[Sand|Sand Tiles]] and [[Farmland]] and is harvested via Forestry.

[[{{FULLPAGENAME}}]] grows in 30-45 minutes.

{{CraftingSection}}
[[Category:Objects]][[Category:Saplings]][[Category:Plants]][[Category:Other Plants]]

Modding/draft

2026-01-16T07:51:54Z

Jamesp1989: /* Next steps */

{{ItemList
|compact
|
What this guide covers
|This is a beginner-focused guide to making a Necesse mod, based on what the game’s mod loader requires for a mod to be considered valid. It focuses on getting a mod to load successfully
}}

= Beginner Guide: Making a Necesse Mod =
== What the game considers a “valid” mod ==
To be loaded by the game, your mod must meet these requirements:
{{ItemList|compact|
|
# '''It must be a <code>.jar</code> file.'''
# '''The jar must contain a <code>mod.info</code> file at the root of the jar.'''
# '''The <code>mod.info</code> must include required fields''' (see below).
# '''The jar must contain exactly one mod entry class''' annotated with <code>@ModEntry</code>.
# '''The mod entry class must have a public no-argument constructor.'''

If any of these are missing, the loader will reject the mod or log an error.
}}
== Step 1: Pick a unique Java package ==
{{ItemList|compact|
|Before writing any code, choose a unique Java package name for your mod.

Avoid using:
* <code>examplemod</code> (the loader warns about this)
* <code>necesse</code> (reserved for the base game)
* the default package (no package)

Use something unique, for example:
* <code>com.yourname.yourmod</code>
 
'''If your mod contains classes in the <code>examplemod</code> package, the loader will log a warning. In dev mod loading it specifically warns that you must move packages to upload, and in normal loading it warns that this will likely not be allowed in future versions.'''
}}
== Step 2: Create the mod.info file ==
{{ItemList|compact|
|
Create a plain text file named <code>mod.info</code>. This file must be included in the jar at the '''root''' (top level).

=== Required fields ===
The loader requires these fields to exist and not be empty:
* <code>id</code>
* <code>name</code>
* <code>version</code>
* <code>gameVersion</code>
* <code>author</code>
* <code>description</code>

=== Optional fields ===
These are supported by the loader and are commonly included:
* <code>clientside</code> (boolean)
* <code>dependencies</code>
* <code>optionalDependencies</code>
}}
=== Example mod.info ===
id = "mytestmod"
name = "My Test Mod"
version = "1.0"
gameVersion = "1.1.1"
author = "YourName"
description = "A beginner test mod."
clientside = false
dependencies = []
optionalDependencies = []

{{ItemList|compact|
|The loader validates the format of <code>id</code>, <code>name</code>, and <code>version</code>. If you use strange characters or invalid version formatting, the mod can be rejected. Keep them simple (letters/numbers, dots, dashes).
}}

== Step 3: Create your Mod Entry class ==
{{ItemList|compact|
|
A mod must have '''exactly one''' “entry point” class marked with the <code>@ModEntry</code> annotation.

Rules:

If the loader finds '''no''' <code>@ModEntry</code> class, the mod will not load.

If the loader finds '''more than one''' <code>@ModEntry</code> class, it errors.

The class must have a '''public no-argument constructor''' because the loader creates it at runtime
}}

=== Minimal example ===
<syntaxhighlight lang=Java>
import necesse.engine.modLoader.annotations.ModEntry;

@ModEntry
public class MyTestMod {
public MyTestMod() {
// Public no-arg constructor required by the loader
}
}
</syntaxhighlight>

== Step 4: Build the jar with the correct contents ==

When you build your mod, the final <code>.jar</code> must contain:

<code>/mod.info</code>

Your compiled class files, including the entry class

A simple “jar contents” checklist:

<code>/mod.info</code>
<code>/com/yourname/mytestmod/MyTestMod.class</code>

== Optional: Mod lifecycle methods ==
The loader can call lifecycle methods on your mod entry class '''if they exist'''. If they do not exist, the loader simply skips them.

Common lifecycle method names include:

<code>preInit()</code>

<code>init()</code>

<code>initResources()</code>

<code>postInit()</code>

<code>initSettings()</code> (special case: if present, it must return a <code>ModSettings</code> type)

<code>dispose()</code>

== Troubleshooting ==
=== “Did not contain a mod.info file” ===

Your jar is missing <code>mod.info</code>, or it is not at the root of the jar.

=== Mod is ignored / not loaded ===

The file is not a <code>.jar</code>.

The jar does not contain a valid <code>mod.info</code>.

No <code>@ModEntry</code> class was found.

=== Error about @ModEntry being used multiple times ===

More than one class in your jar has <code>@ModEntry</code>. You must have exactly one.

=== Entry class fails to construct ===

Your entry class does not have a public no-argument constructor.

=== Warning about examplemod package ===

Some of your classes are in <code>examplemod.*</code>. Move them to a unique package.

== Next steps ==
Once your mod loads successfully, you can start adding actual content and logic. A good first milestone is:

Confirm the game loads your jar with no errors.

Add one small change at a time (so you know what broke if something stops loading).

Modding/draft

2026-01-16T07:51:25Z

Jamesp1989: /* Step 4: Build the jar with the correct contents */

Modding/draft

2026-01-16T07:50:07Z

Jamesp1989: /* Optional: Mod lifecycle methods */

{{ItemList
|compact
|
What this guide covers
|This is a beginner-focused guide to making a Necesse mod, based on what the game’s mod loader requires for a mod to be considered valid. It focuses on getting a mod to load successfully
}}

= Beginner Guide: Making a Necesse Mod =
== What the game considers a “valid” mod ==
To be loaded by the game, your mod must meet these requirements:
{{ItemList|compact|
|
# '''It must be a <code>.jar</code> file.'''
# '''The jar must contain a <code>mod.info</code> file at the root of the jar.'''
# '''The <code>mod.info</code> must include required fields''' (see below).
# '''The jar must contain exactly one mod entry class''' annotated with <code>@ModEntry</code>.
# '''The mod entry class must have a public no-argument constructor.'''

If any of these are missing, the loader will reject the mod or log an error.
}}
== Step 1: Pick a unique Java package ==
{{ItemList|compact|
|Before writing any code, choose a unique Java package name for your mod.

Avoid using:
* <code>examplemod</code> (the loader warns about this)
* <code>necesse</code> (reserved for the base game)
* the default package (no package)

Use something unique, for example:
* <code>com.yourname.yourmod</code>
 
'''If your mod contains classes in the <code>examplemod</code> package, the loader will log a warning. In dev mod loading it specifically warns that you must move packages to upload, and in normal loading it warns that this will likely not be allowed in future versions.'''
}}
== Step 2: Create the mod.info file ==
{{ItemList|compact|
|
Create a plain text file named <code>mod.info</code>. This file must be included in the jar at the '''root''' (top level).

=== Required fields ===
The loader requires these fields to exist and not be empty:
* <code>id</code>
* <code>name</code>
* <code>version</code>
* <code>gameVersion</code>
* <code>author</code>
* <code>description</code>

=== Optional fields ===
These are supported by the loader and are commonly included:
* <code>clientside</code> (boolean)
* <code>dependencies</code>
* <code>optionalDependencies</code>
}}
=== Example mod.info ===
id = "mytestmod"
name = "My Test Mod"
version = "1.0"
gameVersion = "1.1.1"
author = "YourName"
description = "A beginner test mod."
clientside = false
dependencies = []
optionalDependencies = []

{{ItemList|compact|
|The loader validates the format of <code>id</code>, <code>name</code>, and <code>version</code>. If you use strange characters or invalid version formatting, the mod can be rejected. Keep them simple (letters/numbers, dots, dashes).
}}

== Step 3: Create your Mod Entry class ==
{{ItemList|compact|
|
A mod must have '''exactly one''' “entry point” class marked with the <code>@ModEntry</code> annotation.

Rules:

If the loader finds '''no''' <code>@ModEntry</code> class, the mod will not load.

If the loader finds '''more than one''' <code>@ModEntry</code> class, it errors.

The class must have a '''public no-argument constructor''' because the loader creates it at runtime
}}

=== Minimal example ===
<syntaxhighlight lang=Java>
import necesse.engine.modLoader.annotations.ModEntry;

@ModEntry
public class MyTestMod {
public MyTestMod() {
// Public no-arg constructor required by the loader
}
}
</syntaxhighlight>

== Step 4: Build the jar with the correct contents ==
When you build your mod, the final <code>.jar</code> must contain:

<code>/mod.info</code>

Your compiled class files, including the entry class

A simple “jar contents” checklist:

<code>/mod.info</code>
<code>/com/yourname/mytestmod/MyTestMod.class</code>

== Optional: Mod lifecycle methods ==
The loader can call lifecycle methods on your mod entry class '''if they exist'''. If they do not exist, the loader simply skips them.

Common lifecycle method names include:

<code>preInit()</code>

<code>init()</code>

<code>initResources()</code>

<code>postInit()</code>

<code>initSettings()</code> (special case: if present, it must return a <code>ModSettings</code> type)

<code>dispose()</code>

== Troubleshooting ==
=== “Did not contain a mod.info file” ===

Your jar is missing <code>mod.info</code>, or it is not at the root of the jar.

=== Mod is ignored / not loaded ===

The file is not a <code>.jar</code>.

The jar does not contain a valid <code>mod.info</code>.

No <code>@ModEntry</code> class was found.

=== Error about @ModEntry being used multiple times ===

More than one class in your jar has <code>@ModEntry</code>. You must have exactly one.

=== Entry class fails to construct ===

Your entry class does not have a public no-argument constructor.

=== Warning about examplemod package ===

Some of your classes are in <code>examplemod.*</code>. Move them to a unique package.

== Next steps ==
Once your mod loads successfully, you can start adding actual content and logic. A good first milestone is:

Confirm the game loads your jar with no errors.

Add one small change at a time (so you know what broke if something stops loading).

{{Tip
|title=Keep it simple while learning
|text=The easiest way to learn modding is to keep each step small: get the mod to load, then add one feature, test, repeat.
}}

Modding/draft

2026-01-16T07:49:21Z

Jamesp1989: /* Step 4: Build the jar with the correct contents */

{{ItemList
|compact
|
What this guide covers
|This is a beginner-focused guide to making a Necesse mod, based on what the game’s mod loader requires for a mod to be considered valid. It focuses on getting a mod to load successfully
}}

= Beginner Guide: Making a Necesse Mod =
== What the game considers a “valid” mod ==
To be loaded by the game, your mod must meet these requirements:
{{ItemList|compact|
|
# '''It must be a <code>.jar</code> file.'''
# '''The jar must contain a <code>mod.info</code> file at the root of the jar.'''
# '''The <code>mod.info</code> must include required fields''' (see below).
# '''The jar must contain exactly one mod entry class''' annotated with <code>@ModEntry</code>.
# '''The mod entry class must have a public no-argument constructor.'''

If any of these are missing, the loader will reject the mod or log an error.
}}
== Step 1: Pick a unique Java package ==
{{ItemList|compact|
|Before writing any code, choose a unique Java package name for your mod.

Avoid using:
* <code>examplemod</code> (the loader warns about this)
* <code>necesse</code> (reserved for the base game)
* the default package (no package)

Use something unique, for example:
* <code>com.yourname.yourmod</code>
 
'''If your mod contains classes in the <code>examplemod</code> package, the loader will log a warning. In dev mod loading it specifically warns that you must move packages to upload, and in normal loading it warns that this will likely not be allowed in future versions.'''
}}
== Step 2: Create the mod.info file ==
{{ItemList|compact|
|
Create a plain text file named <code>mod.info</code>. This file must be included in the jar at the '''root''' (top level).

=== Required fields ===
The loader requires these fields to exist and not be empty:
* <code>id</code>
* <code>name</code>
* <code>version</code>
* <code>gameVersion</code>
* <code>author</code>
* <code>description</code>

=== Optional fields ===
These are supported by the loader and are commonly included:
* <code>clientside</code> (boolean)
* <code>dependencies</code>
* <code>optionalDependencies</code>
}}
=== Example mod.info ===
id = "mytestmod"
name = "My Test Mod"
version = "1.0"
gameVersion = "1.1.1"
author = "YourName"
description = "A beginner test mod."
clientside = false
dependencies = []
optionalDependencies = []

{{ItemList|compact|
|The loader validates the format of <code>id</code>, <code>name</code>, and <code>version</code>. If you use strange characters or invalid version formatting, the mod can be rejected. Keep them simple (letters/numbers, dots, dashes).
}}

== Step 3: Create your Mod Entry class ==
{{ItemList|compact|
|
A mod must have '''exactly one''' “entry point” class marked with the <code>@ModEntry</code> annotation.

Rules:

If the loader finds '''no''' <code>@ModEntry</code> class, the mod will not load.

If the loader finds '''more than one''' <code>@ModEntry</code> class, it errors.

The class must have a '''public no-argument constructor''' because the loader creates it at runtime
}}

=== Minimal example ===
<syntaxhighlight lang=Java>
import necesse.engine.modLoader.annotations.ModEntry;

@ModEntry
public class MyTestMod {
public MyTestMod() {
// Public no-arg constructor required by the loader
}
}
</syntaxhighlight>

== Step 4: Build the jar with the correct contents ==
When you build your mod, the final <code>.jar</code> must contain:

<code>/mod.info</code>

Your compiled class files, including the entry class

A simple “jar contents” checklist:

<code>/mod.info</code>
<code>/com/yourname/mytestmod/MyTestMod.class</code>

== Optional: Mod lifecycle methods ==
The loader can call lifecycle methods on your mod entry class '''if they exist'''. If they do not exist, the loader simply skips them.

Common lifecycle method names include:

<code>preInit()</code>

<code>init()</code>

<code>initResources()</code>

<code>postInit()</code>

<code>initSettings()</code> (special case: if present, it must return a <code>ModSettings</code> type)

<code>dispose()</code>

{{Tip
|title=Beginner recommendation
|text=Start with only <code>mod.info</code> and an empty <code>@ModEntry</code> class first. Once the game loads your mod successfully, add features step-by-step.
}}

== Troubleshooting ==
=== “Did not contain a mod.info file” ===

Your jar is missing <code>mod.info</code>, or it is not at the root of the jar.

=== Mod is ignored / not loaded ===

The file is not a <code>.jar</code>.

The jar does not contain a valid <code>mod.info</code>.

No <code>@ModEntry</code> class was found.

=== Error about @ModEntry being used multiple times ===

More than one class in your jar has <code>@ModEntry</code>. You must have exactly one.

=== Entry class fails to construct ===

Your entry class does not have a public no-argument constructor.

=== Warning about examplemod package ===

Some of your classes are in <code>examplemod.*</code>. Move them to a unique package.

== Next steps ==
Once your mod loads successfully, you can start adding actual content and logic. A good first milestone is:

Confirm the game loads your jar with no errors.

Add one small change at a time (so you know what broke if something stops loading).

{{Tip
|title=Keep it simple while learning
|text=The easiest way to learn modding is to keep each step small: get the mod to load, then add one feature, test, repeat.
}}

Modding/draft

2026-01-16T07:48:15Z

Jamesp1989: /* Minimal example */

{{ItemList
|compact
|
What this guide covers
|This is a beginner-focused guide to making a Necesse mod, based on what the game’s mod loader requires for a mod to be considered valid. It focuses on getting a mod to load successfully
}}

= Beginner Guide: Making a Necesse Mod =
== What the game considers a “valid” mod ==
To be loaded by the game, your mod must meet these requirements:
{{ItemList|compact|
|
# '''It must be a <code>.jar</code> file.'''
# '''The jar must contain a <code>mod.info</code> file at the root of the jar.'''
# '''The <code>mod.info</code> must include required fields''' (see below).
# '''The jar must contain exactly one mod entry class''' annotated with <code>@ModEntry</code>.
# '''The mod entry class must have a public no-argument constructor.'''

If any of these are missing, the loader will reject the mod or log an error.
}}
== Step 1: Pick a unique Java package ==
{{ItemList|compact|
|Before writing any code, choose a unique Java package name for your mod.

Avoid using:
* <code>examplemod</code> (the loader warns about this)
* <code>necesse</code> (reserved for the base game)
* the default package (no package)

Use something unique, for example:
* <code>com.yourname.yourmod</code>
 
'''If your mod contains classes in the <code>examplemod</code> package, the loader will log a warning. In dev mod loading it specifically warns that you must move packages to upload, and in normal loading it warns that this will likely not be allowed in future versions.'''
}}
== Step 2: Create the mod.info file ==
{{ItemList|compact|
|
Create a plain text file named <code>mod.info</code>. This file must be included in the jar at the '''root''' (top level).

=== Required fields ===
The loader requires these fields to exist and not be empty:
* <code>id</code>
* <code>name</code>
* <code>version</code>
* <code>gameVersion</code>
* <code>author</code>
* <code>description</code>

=== Optional fields ===
These are supported by the loader and are commonly included:
* <code>clientside</code> (boolean)
* <code>dependencies</code>
* <code>optionalDependencies</code>
}}
=== Example mod.info ===
id = "mytestmod"
name = "My Test Mod"
version = "1.0"
gameVersion = "1.1.1"
author = "YourName"
description = "A beginner test mod."
clientside = false
dependencies = []
optionalDependencies = []

{{ItemList|compact|
|The loader validates the format of <code>id</code>, <code>name</code>, and <code>version</code>. If you use strange characters or invalid version formatting, the mod can be rejected. Keep them simple (letters/numbers, dots, dashes).
}}

== Step 3: Create your Mod Entry class ==
{{ItemList|compact|
|
A mod must have '''exactly one''' “entry point” class marked with the <code>@ModEntry</code> annotation.

Rules:

If the loader finds '''no''' <code>@ModEntry</code> class, the mod will not load.

If the loader finds '''more than one''' <code>@ModEntry</code> class, it errors.

The class must have a '''public no-argument constructor''' because the loader creates it at runtime
}}

=== Minimal example ===
<syntaxhighlight lang=Java>
import necesse.engine.modLoader.annotations.ModEntry;

@ModEntry
public class MyTestMod {
public MyTestMod() {
// Public no-arg constructor required by the loader
}
}
</syntaxhighlight>

== Step 4: Build the jar with the correct contents ==
When you build your mod, the final <code>.jar</code> must contain:

<code>/mod.info</code>

Your compiled class files, including the entry class

A simple “jar contents” checklist:

✅ <code>/mod.info</code>

✅ <code>/com/yourname/mytestmod/MyTestMod.class</code>

== Optional: Mod lifecycle methods ==
The loader can call lifecycle methods on your mod entry class '''if they exist'''. If they do not exist, the loader simply skips them.

Common lifecycle method names include:

<code>preInit()</code>

<code>init()</code>

<code>initResources()</code>

<code>postInit()</code>

<code>initSettings()</code> (special case: if present, it must return a <code>ModSettings</code> type)

<code>dispose()</code>

{{Tip
|title=Beginner recommendation
|text=Start with only <code>mod.info</code> and an empty <code>@ModEntry</code> class first. Once the game loads your mod successfully, add features step-by-step.
}}

== Troubleshooting ==
=== “Did not contain a mod.info file” ===

Your jar is missing <code>mod.info</code>, or it is not at the root of the jar.

=== Mod is ignored / not loaded ===

The file is not a <code>.jar</code>.

The jar does not contain a valid <code>mod.info</code>.

No <code>@ModEntry</code> class was found.

=== Error about @ModEntry being used multiple times ===

More than one class in your jar has <code>@ModEntry</code>. You must have exactly one.

=== Entry class fails to construct ===

Your entry class does not have a public no-argument constructor.

=== Warning about examplemod package ===

Some of your classes are in <code>examplemod.*</code>. Move them to a unique package.

== Next steps ==
Once your mod loads successfully, you can start adding actual content and logic. A good first milestone is:

Confirm the game loads your jar with no errors.

Add one small change at a time (so you know what broke if something stops loading).

{{Tip
|title=Keep it simple while learning
|text=The easiest way to learn modding is to keep each step small: get the mod to load, then add one feature, test, repeat.
}}

Modding/draft

2026-01-16T07:46:44Z

Jamesp1989:

{{ItemList
|compact
|
What this guide covers
|This is a beginner-focused guide to making a Necesse mod, based on what the game’s mod loader requires for a mod to be considered valid. It focuses on getting a mod to load successfully
}}

= Beginner Guide: Making a Necesse Mod =
== What the game considers a “valid” mod ==
To be loaded by the game, your mod must meet these requirements:
{{ItemList|compact|
|
# '''It must be a <code>.jar</code> file.'''
# '''The jar must contain a <code>mod.info</code> file at the root of the jar.'''
# '''The <code>mod.info</code> must include required fields''' (see below).
# '''The jar must contain exactly one mod entry class''' annotated with <code>@ModEntry</code>.
# '''The mod entry class must have a public no-argument constructor.'''

If any of these are missing, the loader will reject the mod or log an error.
}}
== Step 1: Pick a unique Java package ==
{{ItemList|compact|
|Before writing any code, choose a unique Java package name for your mod.

Avoid using:
* <code>examplemod</code> (the loader warns about this)
* <code>necesse</code> (reserved for the base game)
* the default package (no package)

Use something unique, for example:
* <code>com.yourname.yourmod</code>
 
'''If your mod contains classes in the <code>examplemod</code> package, the loader will log a warning. In dev mod loading it specifically warns that you must move packages to upload, and in normal loading it warns that this will likely not be allowed in future versions.'''
}}
== Step 2: Create the mod.info file ==
{{ItemList|compact|
|
Create a plain text file named <code>mod.info</code>. This file must be included in the jar at the '''root''' (top level).

=== Required fields ===
The loader requires these fields to exist and not be empty:
* <code>id</code>
* <code>name</code>
* <code>version</code>
* <code>gameVersion</code>
* <code>author</code>
* <code>description</code>

=== Optional fields ===
These are supported by the loader and are commonly included:
* <code>clientside</code> (boolean)
* <code>dependencies</code>
* <code>optionalDependencies</code>
}}
=== Example mod.info ===
id = "mytestmod"
name = "My Test Mod"
version = "1.0"
gameVersion = "1.1.1"
author = "YourName"
description = "A beginner test mod."
clientside = false
dependencies = []
optionalDependencies = []

{{ItemList|compact|
|The loader validates the format of <code>id</code>, <code>name</code>, and <code>version</code>. If you use strange characters or invalid version formatting, the mod can be rejected. Keep them simple (letters/numbers, dots, dashes).
}}

== Step 3: Create your Mod Entry class ==
{{ItemList|compact|
|
A mod must have '''exactly one''' “entry point” class marked with the <code>@ModEntry</code> annotation.

Rules:

If the loader finds '''no''' <code>@ModEntry</code> class, the mod will not load.

If the loader finds '''more than one''' <code>@ModEntry</code> class, it errors.

The class must have a '''public no-argument constructor''' because the loader creates it at runtime
}}

=== Minimal example ===
{{ItemList|compact|
|
import necesse.engine.modLoader.annotations.ModEntry;

@ModEntry
public class MyTestMod {
public MyTestMod() {
// Public no-arg constructor required by the loader
}
}
}}
== Step 4: Build the jar with the correct contents ==
When you build your mod, the final <code>.jar</code> must contain:

<code>/mod.info</code>

Your compiled class files, including the entry class

A simple “jar contents” checklist:

✅ <code>/mod.info</code>

✅ <code>/com/yourname/mytestmod/MyTestMod.class</code>

== Optional: Mod lifecycle methods ==
The loader can call lifecycle methods on your mod entry class '''if they exist'''. If they do not exist, the loader simply skips them.

Common lifecycle method names include:

<code>preInit()</code>

<code>init()</code>

<code>initResources()</code>

<code>postInit()</code>

<code>initSettings()</code> (special case: if present, it must return a <code>ModSettings</code> type)

<code>dispose()</code>

{{Tip
|title=Beginner recommendation
|text=Start with only <code>mod.info</code> and an empty <code>@ModEntry</code> class first. Once the game loads your mod successfully, add features step-by-step.
}}

== Troubleshooting ==
=== “Did not contain a mod.info file” ===

Your jar is missing <code>mod.info</code>, or it is not at the root of the jar.

=== Mod is ignored / not loaded ===

The file is not a <code>.jar</code>.

The jar does not contain a valid <code>mod.info</code>.

No <code>@ModEntry</code> class was found.

=== Error about @ModEntry being used multiple times ===

More than one class in your jar has <code>@ModEntry</code>. You must have exactly one.

=== Entry class fails to construct ===

Your entry class does not have a public no-argument constructor.

=== Warning about examplemod package ===

Some of your classes are in <code>examplemod.*</code>. Move them to a unique package.

== Next steps ==
Once your mod loads successfully, you can start adding actual content and logic. A good first milestone is:

Confirm the game loads your jar with no errors.

Add one small change at a time (so you know what broke if something stops loading).

{{Tip
|title=Keep it simple while learning
|text=The easiest way to learn modding is to keep each step small: get the mod to load, then add one feature, test, repeat.
}}

User:Jamesp1989/common.js

2026-01-16T05:18:18Z

Jamesp1989:

<nowiki>
{
"Enclose with nowiki": {
"wt2html": "<code class=\"mw-highlight mw-highlight-lang-text mw-content-ltr\" dir=\"ltr\" typeof=\"mw:Extension/syntaxhighlight mw:Transclusion\" about=\"#mwt2\" data-parsoid='{\"pi\":[[{\"k\":\"1\"},{\"k\":\"lang\",\"named\":true},{\"k\":\"inline\",\"named\":true}]],\"dsr\":[0,69,null,null]}' data-mw='{\"parts\":[{\"template\":{\"target\":{\"wt\":\"#tag:syntaxhighlight\",\"function\":\"tag\"},\"params\":{\"1\":{\"wt\":\"<nowiki>foo</nowiki>\"},\"lang\":{\"wt\":\"\\\"text\\\"\"},\"inline\":{\"wt\":\"none\"}},\"i\":0}}]}'><nowiki>foo</nowiki></code>",
"html2html": "<code class=\"mw-highlight mw-highlight-lang-text mw-content-ltr\" dir=\"ltr\" typeof=\"mw:Extension/syntaxhighlight mw:Transclusion\" about=\"#mwt2\" data-parsoid='{\"pi\":[[{\"k\":\"1\"},{\"k\":\"lang\",\"named\":true},{\"k\":\"inline\",\"named\":true}]],\"dsr\":[0,69,null,null]}' data-mw='{\"parts\":[{\"template\":{\"target\":{\"wt\":\"#tag:syntaxhighlight\",\"function\":\"tag\"},\"params\":{\"1\":{\"wt\":\"<nowiki>foo</nowiki>\"},\"lang\":{\"wt\":\"\\\"text\\\"\"},\"inline\":{\"wt\":\"none\"}},\"i\":0}}]}'><nowiki>foo</nowiki></code>"
},
"Inline attribute (inline code)": {
"wt2wt": "Text <source lang=\"javascript\" inline=\"\">var a;</source>.",
"selser [1]": "Text <source lang=\"javascript\" inline>var a;</source>.",
"selser [[4,0,4]]": "121y1t4<source lang=\"javascript\" inline>var a;</source>1ibg90y",
"selser [[0,0,2]]": "Text <source lang=\"javascript\" inline>var a;</source>yeuqlm.",
"selser [2]": "brhsc5\n\nText <source lang=\"javascript\" inline>var a;</source>.",
"selser [[0,0,4]]": "Text <source lang=\"javascript\" inline>var a;</source>4x62b6",
"selser [[2,0,0]]": "1mjitw8Text <source lang=\"javascript\" inline>var a;</source>.",
"selser [[0,0,3]]": "Text <source lang=\"javascript\" inline>var a;</source>",
"selser [[2,0,4]]": "uuwnfvText <source lang=\"javascript\" inline>var a;</source>qjkvx1",
"selser [[3,0,3]]": "<source lang=\"javascript\" inline>var a;</source>",
"selser [[4,0,0]]": "uouej0<source lang=\"javascript\" inline>var a;</source>.",
"selser [[3,0,0]]": "<source lang=\"javascript\" inline>var a;</source>.",
"selser [[4,0,3]]": "1wcoh54<source lang=\"javascript\" inline>var a;</source>",
"selser [[2,0,2]]": "11th7ozText <source lang=\"javascript\" inline>var a;</source>1c8ff9m.",
"selser [[2,0,3]]": "1cyv6rText <source lang=\"javascript\" inline>var a;</source>",
"selser [[4,0,2]]": "g6ytvp<source lang=\"javascript\" inline>var a;</source>10gwvyi.",
"selser [[3,0,2]]": "<source lang=\"javascript\" inline>var a;</source>kjtjv6.",
"selser [[3,0,4]]": "<source lang=\"javascript\" inline>var a;</source>zs6oqy"
}
}
</nowiki>

User:Jamesp1989/common.css

2026-01-16T05:16:15Z

Jamesp1989:

/* Stylesheet generated by updateCSS.php */
pre { line-height: 125%; }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.mw-highlight .hll { background-color: #ffffcc }
.mw-highlight { background: #f8f8f8; }
.mw-highlight .c { color: #3D7B7B; font-style: italic } /* Comment */
.mw-highlight .err { border: 1px solid #FF0000 } /* Error */
.mw-highlight .k { color: #008000; font-weight: bold } /* Keyword */
.mw-highlight .o { color: #666666 } /* Operator */
.mw-highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */
.mw-highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */
.mw-highlight .cp { color: #9C6500 } /* Comment.Preproc */
.mw-highlight .cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */
.mw-highlight .c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */
.mw-highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */
.mw-highlight .gd { color: #A00000 } /* Generic.Deleted */
.mw-highlight .ge { font-style: italic } /* Generic.Emph */
.mw-highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
.mw-highlight .gr { color: #E40000 } /* Generic.Error */
.mw-highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.mw-highlight .gi { color: #008400 } /* Generic.Inserted */
.mw-highlight .go { color: #717171 } /* Generic.Output */
.mw-highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
.mw-highlight .gs { font-weight: bold } /* Generic.Strong */
.mw-highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.mw-highlight .gt { color: #0044DD } /* Generic.Traceback */
.mw-highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
.mw-highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
.mw-highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
.mw-highlight .kp { color: #008000 } /* Keyword.Pseudo */
.mw-highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
.mw-highlight .kt { color: #B00040 } /* Keyword.Type */
.mw-highlight .m { color: #666666 } /* Literal.Number */
.mw-highlight .s { color: #BA2121 } /* Literal.String */
.mw-highlight .na { color: #687822 } /* Name.Attribute */
.mw-highlight .nb { color: #008000 } /* Name.Builtin */
.mw-highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */
.mw-highlight .no { color: #880000 } /* Name.Constant */
.mw-highlight .nd { color: #AA22FF } /* Name.Decorator */
.mw-highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */
.mw-highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */
.mw-highlight .nf { color: #0000FF } /* Name.Function */
.mw-highlight .nl { color: #767600 } /* Name.Label */
.mw-highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
.mw-highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */
.mw-highlight .nv { color: #19177C } /* Name.Variable */
.mw-highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
.mw-highlight .w { color: #bbbbbb } /* Text.Whitespace */
.mw-highlight .mb { color: #666666 } /* Literal.Number.Bin */
.mw-highlight .mf { color: #666666 } /* Literal.Number.Float */
.mw-highlight .mh { color: #666666 } /* Literal.Number.Hex */
.mw-highlight .mi { color: #666666 } /* Literal.Number.Integer */
.mw-highlight .mo { color: #666666 } /* Literal.Number.Oct */
.mw-highlight .sa { color: #BA2121 } /* Literal.String.Affix */
.mw-highlight .sb { color: #BA2121 } /* Literal.String.Backtick */
.mw-highlight .sc { color: #BA2121 } /* Literal.String.Char */
.mw-highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */
.mw-highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
.mw-highlight .s2 { color: #BA2121 } /* Literal.String.Double */
.mw-highlight .se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */
.mw-highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */
.mw-highlight .si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */
.mw-highlight .sx { color: #008000 } /* Literal.String.Other */
.mw-highlight .sr { color: #A45A77 } /* Literal.String.Regex */
.mw-highlight .s1 { color: #BA2121 } /* Literal.String.Single */
.mw-highlight .ss { color: #19177C } /* Literal.String.Symbol */
.mw-highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */
.mw-highlight .fm { color: #0000FF } /* Name.Function.Magic */
.mw-highlight .vc { color: #19177C } /* Name.Variable.Class */
.mw-highlight .vg { color: #19177C } /* Name.Variable.Global */
.mw-highlight .vi { color: #19177C } /* Name.Variable.Instance */
.mw-highlight .vm { color: #19177C } /* Name.Variable.Magic */
.mw-highlight .il { color: #666666 } /* Literal.Number.Integer.Long */

User:Jamesp1989/common.js

2026-01-16T05:09:05Z

Jamesp1989:

/* eslint-disable no-console */
(function () {
"use strict";

// --- Config (feel free to tweak) ---
var HLJS_JS = "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js";
var HLJS_CSS = "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/github.min.css";
var ADD_COPY_BUTTON = true;

// --- Helpers ---
function loadCss(url) {
return new Promise(function (resolve, reject) {
var link = document.createElement("link");
link.rel = "stylesheet";
link.href = url;
link.onload = resolve;
link.onerror = reject;
document.head.appendChild(link);
});
}

function loadScript(url) {
return new Promise(function (resolve, reject) {
var s = document.createElement("script");
s.src = url;
s.async = true;
s.onload = resolve;
s.onerror = reject;
document.head.appendChild(s);
});
}

function getLangFromMwHighlight(pre) {
// SyntaxHighlight output often includes classes like: mw-highlight-lang-php
// We convert to highlight.js language names: language-php
var m = (pre.className || "").match(/\bmw-highlight-lang-([a-z0-9_+-]+)\b/i);
return m ? m[1].toLowerCase() : "";
}

function hasTokenSpans(pre) {
// If Pygments ran, it usually inserts lots of span elements for tokens.
// If it failed, you often just get raw text with no spans.
return !!pre.querySelector("span");
}

function ensureSyntaxHighlightCss() {
// If SyntaxHighlight is installed, this module name is commonly available.
// If it isn't, we silently ignore.
if (window.mw && mw.loader) {
try {
mw.loader.load("ext.pygments"); // CSS/theme module from SyntaxHighlight extension
} catch (e) {
// ignore
}
}
}

function addCopyButtons(targetPres) {
if (!navigator.clipboard) return;

targetPres.forEach(function (pre) {
if (pre.dataset && pre.dataset.hasCopyButton) return;

// Wrap in a positioned container
var wrap = document.createElement("div");
wrap.style.position = "relative";
wrap.className = "mw-userjs-codewrap";

pre.parentNode.insertBefore(wrap, pre);
wrap.appendChild(pre);

var btn = document.createElement("button");
btn.type = "button";
btn.textContent = "Copy";
btn.style.position = "absolute";
btn.style.top = "6px";
btn.style.right = "6px";
btn.style.padding = "4px 8px";
btn.style.fontSize = "12px";
btn.style.cursor = "pointer";
btn.style.opacity = "0.85";

btn.addEventListener("click", function () {
navigator.clipboard.writeText(pre.innerText || pre.textContent || "").then(function () {
btn.textContent = "Copied!";
setTimeout(function () { btn.textContent = "Copy"; }, 1200);
}).catch(function () {
btn.textContent = "Failed";
setTimeout(function () { btn.textContent = "Copy"; }, 1200);
});
});

wrap.appendChild(btn);
if (pre.dataset) pre.dataset.hasCopyButton = "1";
});
}

function runHighlightJsOnFailedBlocks() {
var pres = Array.prototype.slice.call(document.querySelectorAll("pre.mw-highlight"));
// Only target blocks that look like SyntaxHighlight output but have no token spans.
var needsClientHighlight = pres.filter(function (pre) {
return !hasTokenSpans(pre);
});

if (!needsClientHighlight.length) {
// Nothing to do.
return;
}

return loadCss(HLJS_CSS)
.then(function () { return loadScript(HLJS_JS); })
.then(function () {
if (!window.hljs) throw new Error("highlight.js did not load");

needsClientHighlight.forEach(function (pre) {
// highlight.js expects a <code> element; if missing, add one.
var code = pre.querySelector("code");
if (!code) {
code = document.createElement("code");
// Preserve original text exactly.
code.textContent = pre.textContent || "";
pre.textContent = "";
pre.appendChild(code);
}

// Set language if we can infer it from mw-highlight-lang-*
var lang = getLangFromMwHighlight(pre);
if (lang) {
code.classList.add("language-" + lang);
}

// Highlight
try {
window.hljs.highlightElement(code);
} catch (e) {
console.warn("[UserJS] highlight.js failed for a block:", e);
}
});

if (ADD_COPY_BUTTON) addCopyButtons(needsClientHighlight);
})
.catch(function (e) {
console.warn("[UserJS] highlight.js fallback could not load/run:", e);
});
}

function init() {
ensureSyntaxHighlightCss();

// If SyntaxHighlight already worked and produced spans, CSS may still be missing.
// Loading ext.pygments above usually solves that.

// If SyntaxHighlight failed (no spans), do client-side fallback.
runHighlightJsOnFailedBlocks();
}

// Run after DOM is ready (MediaWiki-friendly)
if (window.mw && mw.hook) {
mw.hook("wikipage.content").add(function () {
init();
});
} else if (document.readyState === "loading") {
document.addEventListener("DOMContentLoaded", init);
} else {
init();
}
})();

User:Jamesp1989/common.js

2026-01-16T05:05:52Z

Jamesp1989:

w3CodeColor(document.getElementById("myDiv"));
console.log("My name is %s and I am %d years old.", "Bob", 30);
function w3CodeColor(elmnt, mode) {
var lang = (mode || "html");
var elmntObj = (document.getElementById(elmnt) || elmnt);
var elmntTxt = elmntObj.innerHTML;
var tagcolor = "mediumblue";
var tagnamecolor = "brown";
var attributecolor = "red";
var attributevaluecolor = "mediumblue";
var commentcolor = "green";
var cssselectorcolor = "brown";
var csspropertycolor = "red";
var csspropertyvaluecolor = "mediumblue";
var cssdelimitercolor = "black";
var cssimportantcolor = "red";
var jscolor = "black";
var jskeywordcolor = "mediumblue";
var jsstringcolor = "brown";
var jsnumbercolor = "red";
var jspropertycolor = "black";
elmntObj.style.fontFamily = "Consolas,'Courier New', monospace";
if (!lang) {lang = "html"; }
if (lang == "html") {elmntTxt = htmlMode(elmntTxt);}
if (lang == "css") {elmntTxt = cssMode(elmntTxt);}
if (lang == "js") {elmntTxt = jsMode(elmntTxt);}
elmntObj.innerHTML = elmntTxt;

function extract(str, start, end, func, repl) {
var s, e, d = "", a = [];
while (str.search(start) > -1) {
s = str.search(start);
e = str.indexOf(end, s);
if (e == -1) {e = str.length;}
if (repl) {
a.push(func(str.substring(s, e + (end.length))));
str = str.substring(0, s) + repl + str.substr(e + (end.length));
} else {
d += str.substring(0, s);
d += func(str.substring(s, e + (end.length)));
str = str.substr(e + (end.length));
}
}
this.rest = d + str;
this.arr = a;
}
function htmlMode(txt) {
var rest = txt, done = "", php, comment, angular, startpos, endpos, note, i;
comment = new extract(rest, "", commentMode, "W3HTMLCOMMENTPOS");
rest = comment.rest;
while (rest.indexOf("<") > -1) {
note = "";
startpos = rest.indexOf("<");
if (rest.substr(startpos, 9).toUpperCase() == "&LT;STYLE") {note = "css";}
if (rest.substr(startpos, 10).toUpperCase() == "&LT;SCRIPT") {note = "javascript";}
endpos = rest.indexOf(">", startpos);
if (endpos == -1) {endpos = rest.length;}
done += rest.substring(0, startpos);
done += tagMode(rest.substring(startpos, endpos + 4));
rest = rest.substr(endpos + 4);
if (note == "css") {
endpos = rest.indexOf("</style>");
if (endpos > -1) {
done += cssMode(rest.substring(0, endpos));
rest = rest.substr(endpos);
}
}
if (note == "javascript") {
endpos = rest.indexOf("</script>");
if (endpos > -1) {
done += jsMode(rest.substring(0, endpos));
rest = rest.substr(endpos);
}
}
}
rest = done + rest;
for (i = 0; i < comment.arr.length; i++) {
rest = rest.replace("W3HTMLCOMMENTPOS", comment.arr[i]);
}
return rest;
}
function tagMode(txt) {
var rest = txt, done = "", startpos, endpos, result;
while (rest.search(/(\s| )/) > -1) {
startpos = rest.search(/(\s| )/);
endpos = rest.indexOf(">");
if (endpos == -1) {endpos = rest.length;}
done += rest.substring(0, startpos);
done += attributeMode(rest.substring(startpos, endpos));
rest = rest.substr(endpos);
}
result = done + rest;
result = "<" + result.substring(4);
if (result.substr(result.length - 4, 4) == ">") {
result = result.substring(0, result.length - 4) + ">";
}
return "" + result + "";
}
function attributeMode(txt) {
var rest = txt, done = "", startpos, endpos, singlefnuttpos, doublefnuttpos, spacepos;
while (rest.indexOf("=") > -1) {
endpos = -1;
startpos = rest.indexOf("=");
singlefnuttpos = rest.indexOf("'", startpos);
doublefnuttpos = rest.indexOf('"', startpos);
spacepos = rest.indexOf(" ", startpos + 2);
if (spacepos > -1 && (spacepos < singlefnuttpos || singlefnuttpos == -1) && (spacepos < doublefnuttpos || doublefnuttpos == -1)) {
endpos = rest.indexOf(" ", startpos);
} else if (doublefnuttpos > -1 && (doublefnuttpos < singlefnuttpos || singlefnuttpos == -1) && (doublefnuttpos < spacepos || spacepos == -1)) {
endpos = rest.indexOf('"', rest.indexOf('"', startpos) + 1);
} else if (singlefnuttpos > -1 && (singlefnuttpos < doublefnuttpos || doublefnuttpos == -1) && (singlefnuttpos < spacepos || spacepos == -1)) {
endpos = rest.indexOf("'", rest.indexOf("'", startpos) + 1);
}
if (!endpos || endpos == -1 || endpos < startpos) {endpos = rest.length;}
done += rest.substring(0, startpos);
done += attributeValueMode(rest.substring(startpos, endpos + 1));
rest = rest.substr(endpos + 1);
}
return "" + done + rest + "";
}
function attributeValueMode(txt) {
return "" + txt + "";
}
function commentMode(txt) {
return "" + txt + "";
}
function cssMode(txt) {
var rest = txt, done = "", s, e, comment, i, midz, c, cc;
comment = new extract(rest, /\/\*/, "*/", commentMode, "W3CSSCOMMENTPOS");
rest = comment.rest;
while (rest.search("{") > -1) {
s = rest.search("{");
midz = rest.substr(s + 1);
cc = 1;
c = 0;
for (i = 0; i < midz.length; i++) {
if (midz.substr(i, 1) == "{") {cc++; c++}
if (midz.substr(i, 1) == "}") {cc--;}
if (cc == 0) {break;}
}
if (cc != 0) {c = 0;}
e = s;
for (i = 0; i <= c; i++) {
e = rest.indexOf("}", e + 1);
}
if (e == -1) {e = rest.length;}
done += rest.substring(0, s + 1);
done += cssPropertyMode(rest.substring(s + 1, e));
rest = rest.substr(e);
}
rest = done + rest;
rest = rest.replace(/{/g, "{");
rest = rest.replace(/}/g, "}");
for (i = 0; i < comment.arr.length; i++) {
rest = rest.replace("W3CSSCOMMENTPOS", comment.arr[i]);
}
return "" + rest + "";
}
function cssPropertyMode(txt) {
var rest = txt, done = "", s, e, n, loop;
if (rest.indexOf("{") > -1 ) { return cssMode(rest); }
while (rest.search(":") > -1) {
s = rest.search(":");
loop = true;
n = s;
while (loop == true) {
loop = false;
e = rest.indexOf(";", n);
if (rest.substring(e - 5, e + 1) == " ") {
loop = true;
n = e + 1;
}
}
if (e == -1) {e = rest.length;}
done += rest.substring(0, s);
done += cssPropertyValueMode(rest.substring(s, e + 1));
rest = rest.substr(e + 1);
}
return "" + done + rest + "";
}
function cssPropertyValueMode(txt) {
var rest = txt, done = "", s;
rest = ":" + rest.substring(1);
while (rest.search(/!important/i) > -1) {
s = rest.search(/!important/i);
done += rest.substring(0, s);
done += cssImportantMode(rest.substring(s, s + 10));
rest = rest.substr(s + 10);
}
result = done + rest;
if (result.substr(result.length - 1, 1) == ";" && result.substr(result.length - 6, 6) != " " && result.substr(result.length - 4, 4) != "<" && result.substr(result.length - 4, 4) != ">" && result.substr(result.length - 5, 5) != "&") {
result = result.substring(0, result.length - 1) + ";";
}
return "" + result + "";
}
function cssImportantMode(txt) {
return "" + txt + "";
}
function jsMode(txt) {
var rest = txt, done = "", esc = [], i, cc, tt = "", sfnuttpos, dfnuttpos, compos, comlinepos, keywordpos, numpos, mypos, dotpos, y;
for (i = 0; i < rest.length; i++) {
cc = rest.substr(i, 1);
if (cc == "\\") {
esc.push(rest.substr(i, 2));
cc = "W3JSESCAPE";
i++;
}
tt += cc;
}
rest = tt;
y = 1;
while (y == 1) {
sfnuttpos = getPos(rest, "'", "'", jsStringMode);
dfnuttpos = getPos(rest, '"', '"', jsStringMode);
compos = getPos(rest, /\/\*/, "*/", commentMode);
comlinepos = getPos(rest, /\/\//, " ", commentMode);
numpos = getNumPos(rest, jsNumberMode);
keywordpos = getKeywordPos("js", rest, jsKeywordMode);
dotpos = getDotPos(rest, jsPropertyMode);
if (Math.max(numpos[0], sfnuttpos[0], dfnuttpos[0], compos[0], comlinepos[0], keywordpos[0], dotpos[0]) == -1) {break;}
mypos = getMinPos(numpos, sfnuttpos, dfnuttpos, compos, comlinepos, keywordpos, dotpos);
if (mypos[0] == -1) {break;}
if (mypos[0] > -1) {
done += rest.substring(0, mypos[0]);
done += mypos[2](rest.substring(mypos[0], mypos[1]));
rest = rest.substr(mypos[1]);
}
}
rest = done + rest;
for (i = 0; i < esc.length; i++) {
rest = rest.replace("W3JSESCAPE", esc[i]);
}
return "" + rest + "";
}
function jsStringMode(txt) {
return "" + txt + "";
}
function jsKeywordMode(txt) {
return "" + txt + "";
}
function jsNumberMode(txt) {
return "" + txt + "";
}
function jsPropertyMode(txt) {
return "" + txt + "";
}
function getDotPos(txt, func) {
var x, i, j, s, e, arr = [".","<", " ", ";", "(", "+", ")", "[", "]", ",", "&", ":", "{", "}", "/" ,"-", "*", "|", "%"];
s = txt.indexOf(".");
if (s > -1) {
x = txt.substr(s + 1);
for (j = 0; j < x.length; j++) {
cc = x[j];
for (i = 0; i < arr.length; i++) {
if (cc.indexOf(arr[i]) > -1) {
e = j;
return [s + 1, e + s + 1, func];
}
}
}
}
return [-1, -1, func];
}
function getMinPos() {
var i, arr = [];
for (i = 0; i < arguments.length; i++) {
if (arguments[i][0] > -1) {
if (arr.length == 0 || arguments[i][0] < arr[0]) {arr = arguments[i];}
}
}
if (arr.length == 0) {arr = arguments[i];}
return arr;
}
function getKeywordPos(typ, txt, func) {
var words, i, pos, rpos = -1, rpos2 = -1, patt;
if (typ == "js") {
words = ["abstract","arguments","boolean","break","byte","case","catch","char","class","const","continue","debugger","default","delete",
"do","double","else","enum","eval","export","extends","false","final","finally","float","for","function","goto","if","implements","import",
"in","instanceof","int","interface","let","long","NaN","native","new","null","package","private","protected","public","return","short","static",
"super","switch","synchronized","this","throw","throws","transient","true","try","typeof","var","void","volatile","while","with","yield"];
}
for (i = 0; i < words.length; i++) {
pos = txt.indexOf(words[i]);
if (pos > -1) {
patt = /\W/g;
if (txt.substr(pos + words[i].length,1).match(patt) && txt.substr(pos - 1,1).match(patt)) {
if (pos > -1 && (rpos == -1 || pos < rpos)) {
rpos = pos;
rpos2 = rpos + words[i].length;
}
}
}
}
return [rpos, rpos2, func];
}
function getPos(txt, start, end, func) {
var s, e;
s = txt.search(start);
e = txt.indexOf(end, s + (end.length));
if (e == -1) {e = txt.length;}
return [s, e + (end.length), func];
}
function getNumPos(txt, func) {
var arr = [" ", " ", ";", "(", "+", ")", "[", "]", ",", "&", ":", "{", "}", "/" ,"-", "*", "|", "%", "="], i, j, c, startpos = 0, endpos, word;
for (i = 0; i < txt.length; i++) {
for (j = 0; j < arr.length; j++) {
c = txt.substr(i, arr[j].length);
if (c == arr[j]) {
if (c == "-" && (txt.substr(i - 1, 1) == "e" || txt.substr(i - 1, 1) == "E")) {
continue;
}
endpos = i;
if (startpos < endpos) {
word = txt.substring(startpos, endpos);
if (!isNaN(word)) {return [startpos, endpos, func];}
}
i += arr[j].length;
startpos = i;
i -= 1;
break;
}
}
}
return [-1, -1, func];
}
}

User:Jamesp1989/common.css

2026-01-16T05:02:55Z

Jamesp1989: Created blank page

User:Jamesp1989

2026-01-16T05:02:21Z

Jamesp1989:

<div id="myDiv">
<!DOCTYPE html> 
<html> 
<body> 
 
<h1>Testing an HTML Syntax Highlighter</h2> 
Hello world! 
<a href="https://www.w3schools.com">Back to School</a> 
 
</body> 
</html>
</div>

User:Jamesp1989/common.js

2026-01-16T05:01:35Z

Jamesp1989: Created page with "w3CodeColor(document.getElementById("myDiv")); function w3CodeColor(elmnt, mode) { var lang = (mode || "html"); var elmntObj = (document.getElementById(elmnt) || elmnt); var elmntTxt = elmntObj.innerHTML; var tagcolor = "mediumblue"; var tagnamecolor = "brown"; var attributecolor = "red"; var attributevaluecolor = "mediumblue"; var commentcolor = "green"; var cssselectorcolor = "brown"; var csspropertycolor = "red"; var csspropertyvaluecolor = "med..."

w3CodeColor(document.getElementById("myDiv"));

function w3CodeColor(elmnt, mode) {
var lang = (mode || "html");
var elmntObj = (document.getElementById(elmnt) || elmnt);
var elmntTxt = elmntObj.innerHTML;
var tagcolor = "mediumblue";
var tagnamecolor = "brown";
var attributecolor = "red";
var attributevaluecolor = "mediumblue";
var commentcolor = "green";
var cssselectorcolor = "brown";
var csspropertycolor = "red";
var csspropertyvaluecolor = "mediumblue";
var cssdelimitercolor = "black";
var cssimportantcolor = "red";
var jscolor = "black";
var jskeywordcolor = "mediumblue";
var jsstringcolor = "brown";
var jsnumbercolor = "red";
var jspropertycolor = "black";
elmntObj.style.fontFamily = "Consolas,'Courier New', monospace";
if (!lang) {lang = "html"; }
if (lang == "html") {elmntTxt = htmlMode(elmntTxt);}
if (lang == "css") {elmntTxt = cssMode(elmntTxt);}
if (lang == "js") {elmntTxt = jsMode(elmntTxt);}
elmntObj.innerHTML = elmntTxt;

function extract(str, start, end, func, repl) {
var s, e, d = "", a = [];
while (str.search(start) > -1) {
s = str.search(start);
e = str.indexOf(end, s);
if (e == -1) {e = str.length;}
if (repl) {
a.push(func(str.substring(s, e + (end.length))));
str = str.substring(0, s) + repl + str.substr(e + (end.length));
} else {
d += str.substring(0, s);
d += func(str.substring(s, e + (end.length)));
str = str.substr(e + (end.length));
}
}
this.rest = d + str;
this.arr = a;
}
function htmlMode(txt) {
var rest = txt, done = "", php, comment, angular, startpos, endpos, note, i;
comment = new extract(rest, "", commentMode, "W3HTMLCOMMENTPOS");
rest = comment.rest;
while (rest.indexOf("<") > -1) {
note = "";
startpos = rest.indexOf("<");
if (rest.substr(startpos, 9).toUpperCase() == "&LT;STYLE") {note = "css";}
if (rest.substr(startpos, 10).toUpperCase() == "&LT;SCRIPT") {note = "javascript";}
endpos = rest.indexOf(">", startpos);
if (endpos == -1) {endpos = rest.length;}
done += rest.substring(0, startpos);
done += tagMode(rest.substring(startpos, endpos + 4));
rest = rest.substr(endpos + 4);
if (note == "css") {
endpos = rest.indexOf("</style>");
if (endpos > -1) {
done += cssMode(rest.substring(0, endpos));
rest = rest.substr(endpos);
}
}
if (note == "javascript") {
endpos = rest.indexOf("</script>");
if (endpos > -1) {
done += jsMode(rest.substring(0, endpos));
rest = rest.substr(endpos);
}
}
}
rest = done + rest;
for (i = 0; i < comment.arr.length; i++) {
rest = rest.replace("W3HTMLCOMMENTPOS", comment.arr[i]);
}
return rest;
}
function tagMode(txt) {
var rest = txt, done = "", startpos, endpos, result;
while (rest.search(/(\s| )/) > -1) {
startpos = rest.search(/(\s| )/);
endpos = rest.indexOf(">");
if (endpos == -1) {endpos = rest.length;}
done += rest.substring(0, startpos);
done += attributeMode(rest.substring(startpos, endpos));
rest = rest.substr(endpos);
}
result = done + rest;
result = "<" + result.substring(4);
if (result.substr(result.length - 4, 4) == ">") {
result = result.substring(0, result.length - 4) + ">";
}
return "" + result + "";
}
function attributeMode(txt) {
var rest = txt, done = "", startpos, endpos, singlefnuttpos, doublefnuttpos, spacepos;
while (rest.indexOf("=") > -1) {
endpos = -1;
startpos = rest.indexOf("=");
singlefnuttpos = rest.indexOf("'", startpos);
doublefnuttpos = rest.indexOf('"', startpos);
spacepos = rest.indexOf(" ", startpos + 2);
if (spacepos > -1 && (spacepos < singlefnuttpos || singlefnuttpos == -1) && (spacepos < doublefnuttpos || doublefnuttpos == -1)) {
endpos = rest.indexOf(" ", startpos);
} else if (doublefnuttpos > -1 && (doublefnuttpos < singlefnuttpos || singlefnuttpos == -1) && (doublefnuttpos < spacepos || spacepos == -1)) {
endpos = rest.indexOf('"', rest.indexOf('"', startpos) + 1);
} else if (singlefnuttpos > -1 && (singlefnuttpos < doublefnuttpos || doublefnuttpos == -1) && (singlefnuttpos < spacepos || spacepos == -1)) {
endpos = rest.indexOf("'", rest.indexOf("'", startpos) + 1);
}
if (!endpos || endpos == -1 || endpos < startpos) {endpos = rest.length;}
done += rest.substring(0, startpos);
done += attributeValueMode(rest.substring(startpos, endpos + 1));
rest = rest.substr(endpos + 1);
}
return "" + done + rest + "";
}
function attributeValueMode(txt) {
return "" + txt + "";
}
function commentMode(txt) {
return "" + txt + "";
}
function cssMode(txt) {
var rest = txt, done = "", s, e, comment, i, midz, c, cc;
comment = new extract(rest, /\/\*/, "*/", commentMode, "W3CSSCOMMENTPOS");
rest = comment.rest;
while (rest.search("{") > -1) {
s = rest.search("{");
midz = rest.substr(s + 1);
cc = 1;
c = 0;
for (i = 0; i < midz.length; i++) {
if (midz.substr(i, 1) == "{") {cc++; c++}
if (midz.substr(i, 1) == "}") {cc--;}
if (cc == 0) {break;}
}
if (cc != 0) {c = 0;}
e = s;
for (i = 0; i <= c; i++) {
e = rest.indexOf("}", e + 1);
}
if (e == -1) {e = rest.length;}
done += rest.substring(0, s + 1);
done += cssPropertyMode(rest.substring(s + 1, e));
rest = rest.substr(e);
}
rest = done + rest;
rest = rest.replace(/{/g, "{");
rest = rest.replace(/}/g, "}");
for (i = 0; i < comment.arr.length; i++) {
rest = rest.replace("W3CSSCOMMENTPOS", comment.arr[i]);
}
return "" + rest + "";
}
function cssPropertyMode(txt) {
var rest = txt, done = "", s, e, n, loop;
if (rest.indexOf("{") > -1 ) { return cssMode(rest); }
while (rest.search(":") > -1) {
s = rest.search(":");
loop = true;
n = s;
while (loop == true) {
loop = false;
e = rest.indexOf(";", n);
if (rest.substring(e - 5, e + 1) == " ") {
loop = true;
n = e + 1;
}
}
if (e == -1) {e = rest.length;}
done += rest.substring(0, s);
done += cssPropertyValueMode(rest.substring(s, e + 1));
rest = rest.substr(e + 1);
}
return "" + done + rest + "";
}
function cssPropertyValueMode(txt) {
var rest = txt, done = "", s;
rest = ":" + rest.substring(1);
while (rest.search(/!important/i) > -1) {
s = rest.search(/!important/i);
done += rest.substring(0, s);
done += cssImportantMode(rest.substring(s, s + 10));
rest = rest.substr(s + 10);
}
result = done + rest;
if (result.substr(result.length - 1, 1) == ";" && result.substr(result.length - 6, 6) != " " && result.substr(result.length - 4, 4) != "<" && result.substr(result.length - 4, 4) != ">" && result.substr(result.length - 5, 5) != "&") {
result = result.substring(0, result.length - 1) + ";";
}
return "" + result + "";
}
function cssImportantMode(txt) {
return "" + txt + "";
}
function jsMode(txt) {
var rest = txt, done = "", esc = [], i, cc, tt = "", sfnuttpos, dfnuttpos, compos, comlinepos, keywordpos, numpos, mypos, dotpos, y;
for (i = 0; i < rest.length; i++) {
cc = rest.substr(i, 1);
if (cc == "\\") {
esc.push(rest.substr(i, 2));
cc = "W3JSESCAPE";
i++;
}
tt += cc;
}
rest = tt;
y = 1;
while (y == 1) {
sfnuttpos = getPos(rest, "'", "'", jsStringMode);
dfnuttpos = getPos(rest, '"', '"', jsStringMode);
compos = getPos(rest, /\/\*/, "*/", commentMode);
comlinepos = getPos(rest, /\/\//, " ", commentMode);
numpos = getNumPos(rest, jsNumberMode);
keywordpos = getKeywordPos("js", rest, jsKeywordMode);
dotpos = getDotPos(rest, jsPropertyMode);
if (Math.max(numpos[0], sfnuttpos[0], dfnuttpos[0], compos[0], comlinepos[0], keywordpos[0], dotpos[0]) == -1) {break;}
mypos = getMinPos(numpos, sfnuttpos, dfnuttpos, compos, comlinepos, keywordpos, dotpos);
if (mypos[0] == -1) {break;}
if (mypos[0] > -1) {
done += rest.substring(0, mypos[0]);
done += mypos[2](rest.substring(mypos[0], mypos[1]));
rest = rest.substr(mypos[1]);
}
}
rest = done + rest;
for (i = 0; i < esc.length; i++) {
rest = rest.replace("W3JSESCAPE", esc[i]);
}
return "" + rest + "";
}
function jsStringMode(txt) {
return "" + txt + "";
}
function jsKeywordMode(txt) {
return "" + txt + "";
}
function jsNumberMode(txt) {
return "" + txt + "";
}
function jsPropertyMode(txt) {
return "" + txt + "";
}
function getDotPos(txt, func) {
var x, i, j, s, e, arr = [".","<", " ", ";", "(", "+", ")", "[", "]", ",", "&", ":", "{", "}", "/" ,"-", "*", "|", "%"];
s = txt.indexOf(".");
if (s > -1) {
x = txt.substr(s + 1);
for (j = 0; j < x.length; j++) {
cc = x[j];
for (i = 0; i < arr.length; i++) {
if (cc.indexOf(arr[i]) > -1) {
e = j;
return [s + 1, e + s + 1, func];
}
}
}
}
return [-1, -1, func];
}
function getMinPos() {
var i, arr = [];
for (i = 0; i < arguments.length; i++) {
if (arguments[i][0] > -1) {
if (arr.length == 0 || arguments[i][0] < arr[0]) {arr = arguments[i];}
}
}
if (arr.length == 0) {arr = arguments[i];}
return arr;
}
function getKeywordPos(typ, txt, func) {
var words, i, pos, rpos = -1, rpos2 = -1, patt;
if (typ == "js") {
words = ["abstract","arguments","boolean","break","byte","case","catch","char","class","const","continue","debugger","default","delete",
"do","double","else","enum","eval","export","extends","false","final","finally","float","for","function","goto","if","implements","import",
"in","instanceof","int","interface","let","long","NaN","native","new","null","package","private","protected","public","return","short","static",
"super","switch","synchronized","this","throw","throws","transient","true","try","typeof","var","void","volatile","while","with","yield"];
}
for (i = 0; i < words.length; i++) {
pos = txt.indexOf(words[i]);
if (pos > -1) {
patt = /\W/g;
if (txt.substr(pos + words[i].length,1).match(patt) && txt.substr(pos - 1,1).match(patt)) {
if (pos > -1 && (rpos == -1 || pos < rpos)) {
rpos = pos;
rpos2 = rpos + words[i].length;
}
}
}
}
return [rpos, rpos2, func];
}
function getPos(txt, start, end, func) {
var s, e;
s = txt.search(start);
e = txt.indexOf(end, s + (end.length));
if (e == -1) {e = txt.length;}
return [s, e + (end.length), func];
}
function getNumPos(txt, func) {
var arr = [" ", " ", ";", "(", "+", ")", "[", "]", ",", "&", ":", "{", "}", "/" ,"-", "*", "|", "%", "="], i, j, c, startpos = 0, endpos, word;
for (i = 0; i < txt.length; i++) {
for (j = 0; j < arr.length; j++) {
c = txt.substr(i, arr[j].length);
if (c == arr[j]) {
if (c == "-" && (txt.substr(i - 1, 1) == "e" || txt.substr(i - 1, 1) == "E")) {
continue;
}
endpos = i;
if (startpos < endpos) {
word = txt.substring(startpos, endpos);
if (!isNaN(word)) {return [startpos, endpos, func];}
}
i += arr[j].length;
startpos = i;
i -= 1;
break;
}
}
}
return [-1, -1, func];
}
}

Modding/draft

2026-01-16T04:44:34Z

Jamesp1989:

<syntaxhighlight lang="CSS">
/* CSS placed here will be applied to all non-mobile skins */
/* For mobile site, edit MediaWiki:Mobile.css */

html body {
background: url("https://necessewiki.com/mediawiki/images/background.png") no-repeat fixed center bottom / cover #e6e6e6;
height: auto !important;
margin-top: 0 !important;
min-height: 100%;
display: flex;
flex-direction: column;
}

@font-face {
font-family: 'Necessebit';
src: url(https://necessewiki.com/mediawiki/resources/assets/necessebit.ttf) format('truetype');
}

h1, h2 {
border-bottom: 1px solid #83643a !important;;
}

img {
max-width: 100%;
height: auto;
}

.mw-body {
border: 2px solid #100700;
box-shadow: inset #ffb21f 0 0 0 2px, inset #d0812a 0 0 0 4px, inset #2e2018 0 0 0 6px, inset #8e6b54 0 0 0 8px, 0px 0px 10px #000;
margin-right: 1em;
background-color: #bd9e75;
background-image: url("/mediawiki/images/formbackground.png");
border-right-width: 2px;
color: #000;
}

.mw-footer {
text-shadow: 0 0 10px #000, 0 0 10px #000, 0 0 10px #000, 0 0 10px #000;
font-weight: bold;
color: #ccc;
}

.mw-footer a {
color: #1d8df0;
}

.mw-footer li {
color: inherit !important;
}

/* Mobile stuff */
#mw-mf-viewport #mw-mf-page-center {
background: none;
}

#mw-mf-viewport .mw-body {
margin-right: 0.5em;
margin-left: 0.5em;
}

#mw-mf-viewport .last-modified-bar, #mw-mf-viewport .last-modified-bar a, #mw-mf-viewport .last-modified-bar a:visited, #mw-mf-viewport .last-modified-bar .last-modified-text-accent {
color: #ccc;
}

#mw-mf-viewport .last-modified-bar .minerva-icon {
background-color: #ccc;
}

#mw-mf-viewport .last-modified-bar {
background: none;
}

#mw-mf-viewport .last-modified-bar__text {
overflow: initial;
}

#mw-mf-viewport .mw-footer > .post-content {
overflow: initial
}

.page-actions-menu__list-item .cdx-button {
color: #222 !important;;
}

.header-container.header-chrome {
background: none;
}

.catlinks {
background: #e9dcc1;
border: 1px solid #a38d5e;
}

.necesse-title-image {
width: 100%;
max-width: 640px;
height: auto;
}

.necesse-content-cell {
border: 2px solid #191b22;
box-shadow: inset #dbc498 0 0 0 2px, 0px 0px 6px #000;
background: #e9dcc1;
}

.necesse-header {
font-family: 'Necessebit';
font-size: 24px;
font-weight: bold;
color: #111;
text-shadow: 0px 2px 1px #919191;
}

.necesse-main-menu-game {
min-width: 300px;
}
.necesse-main-menu-world {
min-width: 300px;
}

@media only screen and (min-width: 1000px) {
.necesse-main-menu-game {
min-width: 600px;
}
.necesse-main-menu-world {
min-width: 650px;
}
}

.itemplate {
margin: 1px 5px 1px 2px;
display: block;
white-space: nowrap;
}

.necesse-infobox {
box-shadow: inset #dbc498 0 0 0 2px, 0px 0px 6px #000;
border: 2px solid #191b22;
background: #e9dcc1;
float: right;
margin-left: 15px;
margin-bottom: 15px;
min-width: 300px;
}

.content .infobox {
box-shadow: inset #dbc498 0 0 0 2px, 0px 0px 6px #000;
border: 2px solid #191b22;
background: #e9dcc1;
}

.infobox {
float: right;
width: 300px;
}

.content .infobox th, .content .infobox td {
border-bottom: 1px solid #a38d5e;
}

.infobox-table {
width: 100%;
}

.infobox-header {
text-align: center;
font-size: 20px;
}

.infobox-region {
background-color: #ee922c;
border-radius: 5px;
font-weight: bold;
text-align: center;
color: #222;
}

.infobox-section {
padding-left: 10px;
color: black;
white-space: nowrap;
vertical-align: top;
}

.infobox-detail {
padding-right: 10px;
}

.wikitable {
border-collapse: separate;
border: none;
background-color: initial;
}

.wikitable.rounded {
border: 1px solid rgba(0, 0, 0, 0.5);
border-radius: 5px;
padding: 0.1em;
}

.wikitable tr th {
background: #ee922c;
padding: 0.2em 0.4em;
text-align: center;
font-weight: bold;
font-size: 16px;
color: #222;
border: 1px solid #ab7e4c;
}

.wikitable tr th a {
color: #99d;
}

.wikitable tr th a.new {
color: #ba0000;
}

.wikitable tr td {
background: #e9dcc1;
padding: 0.2em 0.4em;
border: 1px solid #a38d5e;
}

.toc, .toccolours {
background: #e9dcc1;
border: 1px solid #a38d5e;
}

figure[typeof~="mw:File/Thumb"], figure[typeof~="mw:File/Frame"] {
background: #e9dcc1;
border: 1px solid #a38d5e;
border-bottom: 0px;
}

figure[typeof~="mw:File/Thumb"] > figcaption, figure[typeof~="mw:File/Frame"] > figcaption {
background: #e9dcc1;
border: 1px solid #a38d5e;
border-top: 0px;
}

figure[typeof~="mw:File/Thumb"] > :not(figcaption) .mw-file-element, figure[typeof~="mw:File/Frame"] > :not(figcaption) .mw-file-element {
background: #e9dcc1;
border: none;
}

pre, code, .mw-code {
background: #e9dcc1;
border: 1px solid #a38d5e;
}

.vector-legacy-sidebar .vector-menu-portal {
box-shadow: inset #dbc498 0 0 0 2px, 0px 0px 6px #000;
border: 2px solid #191b22;
background: #e9dcc1;
}

.vector-legacy-sidebar .vector-menu-portal .vector-menu-heading {
color: #222;
background-image: linear-gradient(to right,rgba(20,20,20,0) 0,#a38d5e 33%,#a38d5e 66%,rgba(20,20,20,0) 100%);
}

.vector-menu-tabs-legacy .selected {
background-image: none;
background: none;
}

.vector-menu-tabs-legacy li {
background-image: none;
background: none;
font-weight: bold;
color: #eee;
text-shadow: 0 0 10px #000, 0 0 10px #000, 0 0 10px #000;
}

.vector-menu-tabs-legacy .selected a {
color: #aee;
}

.vector-menu-tabs-legacy .selected a:visited {
color: #aee;
}

.vector-menu-tabs-legacy .new a {
color: inherit;
}

.vector-menu-tabs-legacy li a {
color: inherit;
}

.vector-menu-tabs, .vector-menu-tabs a, #mw-head .vector-menu-dropdown .vector-menu-heading {
background-image: none;
}

.vector-menu-dropdown {
background-image: none;
font-weight: bold;
color: #eee;
text-shadow: 0 0 10px #000, 0 0 10px #000, 0 0 10px #000;
}

.vector-menu-dropdown .vector-menu-heading {
color: inherit;
font-weight: inherit;
}

.vector-menu-dropdown .vector-menu-content {
box-shadow: inset #dbc498 0 0 0 2px, 0px 0px 6px #000;
border: 2px solid #191b22;
background: #e9dcc1;
}

.vector-menu-dropdown .mw-list-item a {
color: #222;
text-shadow: none;
}

.vector-search-box {
background-image: none;
}

#p-personal {
box-shadow: inset #dbc498 0 0 0 2px, 0px 0px 6px #000;
border: 2px solid #191b22;
background: #e9dcc1;
background: none;
border: none;
box-shadow: none;
color: #eee;
font-weight: bold;
text-shadow: 0 0 10px #000, 0 0 10px #000;
}

#p-personal a.new {
color:inherit;
}

#p-personal a:visited {
color:inherit;
}

#p-personal a {
color:inherit;
}
</syntaxhighlight>

Modding/draft

2026-01-16T04:41:14Z

Jamesp1989:

<syntaxhighlight lang="python" inline>lambda x: x * 2</syntaxhighlight> is a [[w:Lambda (programming)|lambda expression]] in Python.

Modding/draft

2026-01-16T04:39:36Z

Jamesp1989:

Battle Chef

2026-01-14T13:40:05Z

Jamesp1989:

{{Infobox mob
|name = {{FULLPAGENAME}}
|image = {{FULLPAGENAME}}.png
|type = Monsters
|health = 900
|armor = 30
|damage = ?
|speed = ?
|drops = '''Drops one of the following:''' {{Item|Battle Chef's Hat|addon=33.⅓%|}} {{Item|Battle Chef's Chestplate|addon=33.⅓%}} {{Item|Battle Chef's Boots|addon=33.⅓%}}
'''And if your lucky:'''
{{Item|Rolling Pin|addon=2%}}
{{Item|Butcher's Cleaver|addon=2%}}
{{Item|Chef's Special|addon=0.5%}}

}}

[[Category:Monsters]]

[[{{FULLPAGENAME}}]] is an enemy found during [[Incursions]], in Chef invasions.

Battle Chef

2026-01-14T13:39:23Z

Jamesp1989:

{{Infobox mob
|name = {{FULLPAGENAME}}
|image = {{FULLPAGENAME}}.png
|type = Monsters
|health = 900
|armor = 30
|damage = ?
|speed = ?
|drops = '''Drops one of the following:''' {{Item|Battle Chef's Hat|addon=33.⅓%|}} {{Item|Battle Chef's Chestplate|addon=33.⅓%}} {{Item|Battle Chef's Boots|addon=33.⅓%}}
'''and if your lucky:'''
{{Item|Rolling Pin|addon=2%}}
{{Item|Butcher's Cleaver|addon=2%}}
{{Item|Chef's Special|addon=0.5%}}

}}

[[Category:Monsters]]

[[{{FULLPAGENAME}}]] is an enemy found during [[Incursions]], in Chef invasions.

Battle Chef

2026-01-14T13:37:23Z

Jamesp1989: added additional drop items

{{Infobox mob
|name = {{FULLPAGENAME}}
|image = {{FULLPAGENAME}}.png
|type = Monsters
|health = 900
|armor = 30
|damage = ?
|speed = ?
|drops = '''Drops one of the following:''' {{Item|Battle Chef's Hat|addon=33.⅓%|}} {{Item|Battle Chef's Chestplate|addon=33.⅓%}} {{Item|Battle Chef's Boots|addon=33.⅓%}}
{{Item|Rolling Pin|addon=2%}}
{{Item|Butcher's Cleaver|addon=2%}}
{{Item|Chef's Special|addon=0.5%}}

}}

[[Category:Monsters]]

[[{{FULLPAGENAME}}]] is an enemy found during [[Incursions]], in Chef invasions.

Module:NecesseCache

2026-01-11T16:23:26Z

Jamesp1989: Undo revision 24632 by Jamesp1989 (talk)

local p = {}

function p.loadItems()
return load('necesse_items', 'Module:NecesseItems/data')
end

function p.purgeItems()
mw.ext.LuaCache.delete('necesse_items')
end

function p.loadRecipes()
return load('necesse_recipes', 'Module:NecesseRecipes/data')
end

function p.purgeRecipes()
mw.ext.LuaCache.delete('necesse_recipes')
end

function load(cache, module)
-- First try to load it from the cache
local success, result = pcall(function()
return mw.text.jsonDecode(mw.ext.LuaCache.get(cache))
end)
if success and result then
return result
end

-- Now load it from the module and cache it
local data = require(module)
mw.ext.LuaCache.set(cache, mw.text.jsonEncode(data))
return data
end

return p

Module:NecesseCache

2026-01-11T16:17:35Z

Jamesp1989:

local p = {}

function p.loadItems()
return load('necesse_items', 'Module:NecesseItems/data')
end

function p.purgeItems()
mw.ext.LuaCache.delete('necesse_items')
end

function p.loadRecipes()
return load('necesse_recipes', 'Module:NecesseRecipes/data')
end

function p.purgeRecipes()
mw.ext.LuaCache.delete('necesse_recipes')
end

function p.loadPlacement()
return load('necesse_placement', 'Module:NecessePlacement/data')
end

function p.purgePlacement()
mw.ext.LuaCache.delete('necesse_placement')
end

function load(cache, module)
-- First try to load it from the cache
local success, result = pcall(function()
return mw.text.jsonDecode(mw.ext.LuaCache.get(cache))
end)
if success and result then
return result
end

-- Now load it from the module and cache it
local data = require(module)
mw.ext.LuaCache.set(cache, mw.text.jsonEncode(data))
return data
end

return p

User:Jamesp1989

2026-01-11T16:14:46Z

Jamesp1989:

[[{{FULLPAGENAME}}/LODRAFT]]

{{#invoke:NecessePlacement|formatValidTiles|palmsapling}}

Multiplayer

2026-01-10T22:18:36Z

Jamesp1989: /* Rent a dedicated server */

This article covers the complete setup process for a Necesse Dedicated server.

If you want to set up a Linux dedicated server specifically, you can follow [[Multiplayer-Linux|this guide]].

中文开服教程请参考：[[Multiplayer Chinese]]

==Dedicated Server vs in-game world hosting==
It is not necessary to have a dedicated server in order to play multiplayer with others. Players can host their worlds in-game as well. A hosted world will be hosted on Steam, specifically in the location of your download region.

The one advantage a dedicated server offers is the server/world will always be online and accessible. In the case of world hosting, the owner of the world will need to be online and in the world for other players to join.

If your group won't be playing if the owner isn't online, your group can opt for in-game hosting instead.

== Rent a dedicated server ==
If you'd rather rent a dedicated game server hosted by a 3rd party, by making a purchase through this Shockbyte link you will support the developers of Necesse:

* [https://shockbyte.com/partner/necesse Shockbyte]

Other options are:

* [https://pingperfect.com/gameservers/necesse-game-server-hosting.php Pingperfect]
* [https://www.bisecthosting.com/game-server-hosting BisectHosting]
* [https://citadelservers.com/game-servers/necesse-hosting CitadelServers]
* [https://www.gamehostbros.com/necesse-server-hosting/ Game Host Bros]
* [https://aagamehosting.com/game-servers/necesse-hosting AA Game Hosting]
* [https://berrybyte.net/necesse-server-hosting berrybyte]
* [https://www.kinetichosting.com/game-servers/necesse/order Kinetic Hosting]
* [https://wabbanode.com/games/necesse-server-hosting Wabbanode]
* [https://supercraft.host/necesse-server-hosting Supercraft]
* Any VPS hosting service, like AWS EC2

== Downloading Server Files ==

Downloading the server files can be performed in two different ways, which are:

'''Through Steam'''

Navigate to your Steam library and filter for tools
[[File:Filter for Tools.png|thumb]]

Identify 'Necesse Dedicated Server' and click install
[[File:Download Necesse Dedicated Server.png|thumb]]

[[File:Necesse Dedicated Server via Steam.png|thumb]]

'''Through SteamCMD'''

See Valve's developer wiki for how to download and install SteamCMD: https://developer.valvesoftware.com/wiki/SteamCMD

Once installed, run SteamCMD by double-clicking the steamcmd.exe in the installation folder.

In the SteamCMD window, type in the following:

<code>login anonymous</code>

To change where the dedicated server is installed, use the command force_install_dir C:\Necesse
That would tell SteamCMD to install the Necesse Dedicated server files to a folder called Necesse on your PC's C drive

Next, download the server files to the specified folder by typing:

<code>app_update 1169370 validate</code>

When the process has completed, it will say "Success! App '1169370' fully installed." You can then close Steam CMD by typing:

<code>quit</code>

'''Through download'''

You can also download the server files located at https://necessegame.com/server/

== Port Forwarding ==

The protocol and default port for Necesse is UDP and port 14159. You will need to open these ports on your router and server's Windows Firewall.

'''Router'''

Login to your router.

Navigate to your routers port forwarding section.

Create the port forward entries in your router.

'''Windows Firewall'''

Navigate to Control Panel → System and Security → Windows Firewall.

Select "Advanced settings" and highlight "Inbound Rules" in the left pane.

Right click Inbound Rules and select "New Rule..."

Click the "Port" circle and click "Next"
[[File:Firewall Select "Port".png|thumb]]

Select the protocol (UDP) and the port number (if you've followed this example, it would be 14159) in the "Specific local ports:" text box and click Next.

Select "Allow the connection" in the next window and click Next.

Select the network type as you see fit and click Next.

Name the rule "Necesse Server" and click Finish.

'''Port Forwarding Testing'''

Test that your ports are forwarded correctly by entering your public IP address and the port number on this site: https://portchecker.co/

Note that port checkers sometimes report false negatives, if you have done everything correct and you can see your server listening on a netstat scan, it may be worth checking if people can join anyway.

== Running the server ==
To run the server, navigate to wherever you installed the server files, if you've followed the exact steps from this guide, it would be C:\Necesse

Locate the file called "StartServer.bat" and double-click it, a new window will appear, this is the dedicated server program.

You will be asked to name the world, type your desired world name into the text box and click "Enter"

If you want custom server options, type in "y" and click "Enter", if you do not, type "n" and click "Enter"

It will ask you to specify the "host port" this is the port we forwarded earlier, so type in 14159 and then click "Enter"

Then, it will ask for the amount of player slots, type in a number between 1 and 250, and click "Enter"

Next, it will ask whether you want a server password, if you do, type in the server password, don't type anything if you don't want a server password, and click "Enter"

It will ask you to specify custom spawn island, leave blank for random or enter a custom spawn island in the format: <x>,<y> and click "Enter"

Then you'll be asked to specify spawn seed, enter a random number or leave blank for random, and click "Enter"

You'll then be asked to choose whether to spawn the guide house, type in "y" for yes or "n" for no, and click "Enter"

Click "Enter" one final time, to start up the server.

Leave the dedicated server program window open to keep the server running, when you want to shut down the server, type "quit" into the text box and click "Enter" or click the X at the top right of the window.

== How to join the server ==
* Run the game from Steam

* Click "Multiplayer"

* Click "Add Server"

* Type a name that will help you remember the server in the "Name" field

* Type your '''public IPv4 address''' (which can be found here: https://whatismyipaddress.com/) in the "IP address" field. IPs in the '''192.168.0.0-192.168.255.255 range are private''', and others will not be able to connect to it unless they're on the same network.

* Type your server port which if you've followed this guide is 14159 in the "Port Number" field

* Click "Add"

* Your server will now appear in the "Multiplayer" menu, double-click it to join (or click it once then click "Join Server")

== Configuring the server ==
If you want to change the configuration of your server (after the initial setup) you will need to edit some files. They can be edited using any Text Editor program, such as Notepad (pre-installed to all Windows based PC's)

Before editing any configuration files, you should ALWAYS stop your server first.

To navigate to the server's configuration files (and save files) type %appdata% into the Windows search bar, then double-click the "Necesse" folder

The server configuration file is named "server.cfg" and is located at C:\Users\YourPCUsernameHere\AppData\Roaming\Necesse\cfg

The world configuration file is named "worldSettings.cfg" and is located at C:\Users\YourPCUsernameHere\AppData\Roaming\Necesse\saves\YourWorldNamehere.zip

The world is in a Compressed (zipped) .zip folder by default, meaning you will have to extract the files contained inside by right-clicking and selecting "Extract Here" - rename the original YourWorldNameHere.zip to something different.

Then you need to edit the "worldSettings.cfg" file.

Then right-click the YourWorldNameHere folder, and hover over "Send to" and click "Compressed (zipped) folder"

== File Locations ==

'''By default'''

The server configuration file is named "server.cfg" and is located at C:\Users\YourPCUsernameHere\AppData\Roaming\Necesse\cfg

The world configuration file is named "worldSettings.cfg" and is located at C:\Users\YourPCUsernameHere\AppData\Roaming\Necesse\saves\YourWorldNamehere.zip

The save data is the .zip named according to the world name, and is located at C:\Users\YourPCUsernameHere\AppData\Roaming\Necesse\saves\

The server logs are found at C:\Users\YourPCUsernameHere\AppData\Roaming\Necesse\logs

'''Customizations'''

Forcing configs to the game directory can be done with the -localdir parameter in bat file

== Server and chat commands ==

Commands can be run from the server command line, or from the in-game chat if the user have the required permissions.
If you are hosting or playing singleplayer, you have all command permissions. When joining a server, you start with user permissions. Permissions can be assigned with the <code>/permissions set <name> <permission></code> command. If you start the server with the <code>-owner <name></code> launch option, any player joining with this name will get owner permissions.

Commands that require cheats enabled will give a warning before attempting to use them. Using them will disable achievements on the world in which you use them.

{| class="wikitable"
! Command || Permissions || Action || Cheats
|-
| /help [<page/command>] || User || Lists all commands or gives information about a specific command ||
|-
| /playtime || User || Shows your current playtime on the server ||
|-
| /me <action> || User || Declare an action to the entire server ||
|-
| /w, /whisper or /pm <player> <message> || User || Whisper a message to another player ||
|-
| /mypermissions || User || Shows your permission level ||
|-
| /die || User || Kills yourself ||
|-
| /performance [<includeServer>] [<seconds>] || User || Records server performance over some seconds and creates a file with the results ||
|-
| /createteam || User || Creates a new team for yourself ||
|-
| /leaveteam || User || Leaves your current team ||
|-
| /invite <player> || User || Invites a player to your team ||
|-
| /network || Moderator || Shows network usage this session ||
|-
| /players || Moderator || Lists players currently online ||
|-
| /playernames || Moderator || Lists all authentications and their names ||
|-
| /levels || Moderator || Lists currently loaded levels ||
|-
| /save || Moderator || Saves all data ||
|-
| /kick <player> [<message/reason>] || Moderator || Kicks player from the server ||
|-
| /say <message> || Moderator || Talks in the chat as Server ||
|-
| /mow <range> [<chance>] || Admin || Mows ground of grass in range with percent chance || ✓
|-
| /time <set/add> [<amount>] || Admin || Sets/adds world time (can use (mid)day or (mid)night) || ✓
|-
| /clearall [<global>] || Admin || Clears all entities || ✓
|-
| /clearmobs [<global> [<type>]] || Admin || Clears all mobs or a specific type on your level or on all loaded levels || ✓
|-
| /clearevents [<global> [<type>]] || Admin || Clears all events on your level or on all loaded levels || ✓
|-
| /tp [<player1>] <player2/home/death/spawn> || Admin || Teleports player1 to player2 or other location || ✓
|-
| /print <message> || Admin || Prints a message in the chat ||
|-
| /give [<player>] <item> [<amount>] || Admin || Gives item to player || ✓
|-
| /buff [<player>] <buff> [<seconds>] || Admin || Gives buff to player || ✓
|-
| /clearbuff [<player>] <buff> || Admin || Clears buff from player || ✓
|-
| /reveal [<player>] || Admin || Reveals entire clients current level || ✓
|-
| /setisland [<player>] <islandX> <islandY> [<dimension>] || Admin || Changes the island of the player || ✓
|-
| /setdimension [<player>] <dimension> || Admin || Changes the dimension of player || ✓
|-
| /hp [<player>] <health> || Admin || Sets the health of player || ✓
|-
| /maxhp [<player>] <health> || Admin || Sets the max health of player || ✓
|-
| /mana [<player>] <mana> || Admin || Sets the mana of player || ✓
|-
| /maxmana [<player>] <mana> || Admin || Sets the max mana of player || ✓
|-
| /hunger [<player>] <hunger> || Admin || Sets the hunger percent of player || ✓
|-
| /deleteplayer <authentication/fullname> || Admin || Deletes a players files in the saved players folder ||
|-
| /settings <list/setting> [<arg>] || Admin || Change server world settings ||
|-
| /difficulty <list/difficulty> || Admin || Changes difficulty setting ||
|-
| /deathpenalty <list/penalty> || Admin || Changes death penalty setting ||
|-
| /raids <list/frequency> || Admin || Changes raids frequency setting ||
|-
| /pausewhenempty <0/1> || Admin || Enable/disable pause when empty setting ||
|-
| /maxlatency <seconds> || Admin || Sets the max latency before client timeout ||
|-
| /ban <authentication/name> || Admin || Bans a player ||
|-
| /unban <authentication/name> || Admin || Removes a ban ||
|-
| /bans || Admin || Lists all current bans ||
|-
| /rain [<islandX> <islandY> <dimension>] <start/clear> || Admin || Sets the rain on the level || ✓
|-
| /enchant <clear/set/random> [<slot>] [<enchantID>] || Admin || Clears, sets or gives a random enchant (use -1 slot for selected item) || ✓
|-
| /copyitem [<slot>] || Admin || Copies an item and all of its data || ✓
|-
| /healmobs <health> [<range>] [<filter>] || Admin || Heals mobs around you || ✓
|-
| /copyplayer <from> <to> || Admin || Copy a players inventory, position and health over to another || ✓
|-
| /demo [<player>] [<setup> [<forceNew>]] [<builds>] || Admin || Setups up a world and/or build for player || ✓
|-
| /getteam <player> || Admin || Gets the current team of the player ||
|-
| /clearteam <player> || Admin || Removes the player from his current team ||
|-
| /setteam <player> <team> || Admin || Sets the team of the player. ||
|-
| /setteamowner <team> <player> || Admin || Sets the owner of the team. The new owner must be part of the team already ||
|-
| /motd <clear/get/message> || Admin || Sets or clears the message of the day. Use \n for new line ||
|-
| /changename <player> <name> || Admin || Changes the name of a player ||
|-
| /sharemap [<from>] <to> || Admin || Shares your map discoveries with another player || ✓
|-
| /stop, /exit or /quit || Owner || Saves and stops the server ||
|-
| /password [<password>] || Owner || Set a password of the server, blank will be no password ||
|-
| /permissions <list/set/get> [<authentication/name> [<permissions>]] || Owner || Sets a players permissions ||
|-
| /regen [<islandX> <islandY> <dimension>] [<biome>] [<seeded>] || Owner || Regenerates the entire level || ✓
|-
| /allowcheats || Owner || Enables/allows cheats on this world (NOT REVERSIBLE) || ✓
|-
| /itemgnd [<slot>] <set/get/clear> [<key> [<value>]] || Owner || Gets or sets item GND data || ✓
|-
| /jobsearchrange <range> || Owner || Sets the job search tile range of settlers ||
|-
| /language <language> || Server || Sets server language settings ||
|}

== Server Parameters ==

The following parameters can be added to customize server configuration. Found in <code>Necesse.jar</code> under <code>necesse.engine.platforms.desktop.server</code> package, <code>DesktopServerWrapper.class</code> file.

Parameters not given will be loaded from server settings file.

{| class="wikitable"
! Parameter || Description
|-
| -help || Shows this help menu
|-
| -nogui || Runs the server in terminal instead of opening the GUI
|-
| -settings <code><file></code> || Settings file path to load server settings from
|-
| -world <code><name></code> || World to load instead of being asked which to load
|-
| -port <code><port></code> || Port to host at
|-
| -slots <code><slots></code> || Amount of player slots
|-
| -owner <code><name></code> || Anyone that connects with this name, will get owner permissions
|-
| -motd <code><message></code> || Sets the message of the day. Use \\n for new line
|-
| -password <code><password></code> || The password for the server, blank for no password
|-
| -pausewhenempty <code><1/0></code> || Pauses the world when there are no players in server, defaults 0
|-`
| -giveclientspower <code><1/0></code> || If the server should check client actions, a kind of anti-cheat. When off it will give a much smoother experience for clients. Defaults off.
|-
| -logging <code><1/0></code> || If on the server will generate a log file for each session, defaults 1
|-
| -logs <code><folder></code> || What folder to place the logs, if logging is enabled
|-
| -zipsaves <code><1/0></code> || If saves should be compressed, defaults to 1
|-
| -language <code><language></code> || Sets the language of the server, only used for occasional messages in log
|-
| -ip <code><address></code> || Binds the server IP to the address
|-
| -datadir <code><path></code> || Sets the path where cache, latest log, saves etc. are stored. Defaults to Necesse folder in appdata on different platforms
|-
| -localdir || Same as -datadir, but uses the local directory the server is launched from
|-
| -ignoreseasons || Disables seasonal content, e.g. [[Christmas Present]], [[Christmas Hat]], etc.
|}

Crops

2026-01-08T16:29:24Z

Jamesp1989: added beet seed

{{Infobox item
|type = [[Plants]]
}}

[[Crops]] are used for [[cooking]]. They can be grown by planting [[Seeds|seeds]] in [[Farmland]]. When harvested, they will drop a random amount of [[Crops]] and 1 - 2 [[Seeds|seeds]]. Each crop has 5 growth stages, and the time it takes for one growth stage to complete is randomized each time it starts, somewhere between 7 and 10 minutes, and 4 and 7 minutes for Wheat. 

The [[Fertilizer]] can be used on [[Crops]] to speed up growth. 

==Crops==
The '''Price''' listed below is the '''best price''' per single crop. 
An asterisk (*) in the '''Earning per harvest''' column means that a seed was excluded for replanting purposes.
* The '''Earning per harvest''' column excludes the earnings from selling extra seeds that could be dropped per harvest (all seeds from crops that don't exclusively drop seeds sell for the same price of 1 [[File:Coin_Currency.png]] and have the same drop chances).

* There might be more profitable methods to use a crop (such as processing [[Rice Seeds]](1[[File:Coin_Currency.png]]) into [[Rice]] (3[[File:Coin_Currency.png]]) into selling.

{| class="wikitable"
|+
|-
! Seed !! Growth !! Crop !! Drops !! Minutes per Drop !! Price !! Earning per harvest
|-
| {{Item|Cabbage Seeds|inline=1}} || [[File:Growing_Cabbage.gif]] || {{Item|Cabbage|inline=1}} || 1 - 2 || 17.5 - 25 || 2 [[File:Coin_Currency.png]] [[File:Pawnbroker.png]] || 2 - 4 [[File:Coin_Currency.png]]
|-
| {{Item|Carrot Seeds|inline=1}} || [[File:Growing_Carrot.gif]] || {{Item|Carrot|inline=1}} || 1 - 2 || 17.5 - 25 || 2 [[File:Coin_Currency.png]] [[File:Pawnbroker.png]] || 2 - 4 [[File:Coin_Currency.png]]
|-
| {{Item|Chili Pepper Seeds|inline=1}} || [[File:Growing_Chili_Pepper.gif]] || {{Item|Chili Pepper|inline=1}} || 1 - 3 || 11.67 - 16.67 || 2 [[File:Coin_Currency.png]] [[File:Pawnbroker.png]] || 2 - 6 [[File:Coin_Currency.png]]
|-
| {{Item|Coffee Beans|inline=1}} || [[File:Growing_Coffee_Beans.gif]] || {{Item|Coffee Beans|inline=1}} || 1 - 5 || 7 - 10 || 3 [[File:Coin_Currency.png]] [[File:Pawnbroker.png]] || 0 - 12 [[File:Coin_Currency.png]]*
|-
| {{Item|Corn Seeds|inline=1}} || [[File:Growing_Corn.gif]] || {{Item|Corn|inline=1}} || 1 - 3 || 11.67 - 16.67 || 2 [[File:Coin_Currency.png]] [[File:Pawnbroker.png]] || 2 - 6 [[File:Coin_Currency.png]]
|-
| {{Item|Eggplant Seeds|inline=1}} || [[File:Growing_Eggplant.gif]] || {{Item|Eggplant|inline=1}} || 1 - 2 || 17.5 - 25 || 2 [[File:Coin_Currency.png]] [[File:Pawnbroker.png]] || 2 - 4 [[File:Coin_Currency.png]]
|-
| {{Item|Onion Seeds|inline=1}} || [[File:Growing_Onion.gif]] || {{Item|Onion|inline=1}} || 1 - 2 || 17.5 - 25 || 3 [[File:Coin_Currency.png]] [[File:Pawnbroker.png]] || 3 - 6 [[File:Coin_Currency.png]]
|-
| {{Item|Potato Seeds|inline=1}} || [[File:Growing_Potato.gif]] || {{Item|Potato|inline=1}} || 1 - 3 || 11.67 - 16.67 || 2 [[File:Coin_Currency.png]] [[File:Pawnbroker.png]] || 2 - 6 [[File:Coin_Currency.png]]
|-
| {{Item|Pumpkin Seeds|inline=1}} || [[File:Growing_Pumpkin.gif]] || {{Item|Pumpkin|inline=1}} || 1 - 2 || 17.5 - 25 || 5 [[File:Coin_Currency.png]] [[File:Pawnbroker.png]] || 5 - 10 [[File:Coin_Currency.png]]
|-
| {{Item|Rice Seeds|inline=1}}|| [[File:Growing_Rice.gif]] || {{Item|Rice Seeds|inline=1}} || 2 - 5 || 11.67 - 16.67 || 1 [[File:Coin_Currency.png]] [[File:Pawnbroker.png]] || 1 - 4 [[File:Coin_Currency.png]]*
|-
| {{Item|Strawberry Seeds|inline=1}} || [[File:Growing_Strawberry.gif]] || {{Item|Strawberry|inline=1}} || 1 - 4 || 8.75 - 12.5 || 3 [[File:Coin_Currency.png]] [[File:Pawnbroker.png]] || 3 - 12 [[File:Coin_Currency.png]]
|-
| {{Item|Sugar Beet Seeds|inline=1}} || [[File:Growing_Sugar Beet.gif]] || {{Item|Sugar Beet|inline=1}} || 1 - 2 || 17.5 - 25 || 2 [[File:Coin_Currency.png]] [[File:Pawnbroker.png]] || 2 - 4 [[File:Coin_Currency.png]]
|-
| {{Item|Tomato Seeds|inline=1}} || [[File:Growing_Tomato.gif]] || {{Item|Tomato|inline=1}} || 1 - 3 || 11.67 - 16.67 || 2 [[File:Coin_Currency.png]] [[File:Pawnbroker.png]] || 2 - 6 [[File:Coin_Currency.png]]
|-
| {{Item|Beet Seeds|inline=1}} || [[File:Growing_Beet.gif]] || {{Item|Beet|inline=1}} || 1 - 2 || 5 - 8.75 || 9 [[File:Coin_Currency.png]] [[File:Farmer.png]] || 5-10 [[File:Coin_Currency.png]]
|-
| {{Item|Wheat Seeds|inline=1}} || [[File:Growing_Wheat.gif]] || {{Item|Wheat|inline=1}} || 1 - 4 || 5 - 8.75 || 9 [[File:Coin_Currency.png]] [[File:Farmer.png]] || 9 - 36 [[File:Coin_Currency.png]]
|}

[[Category:Plants]]

Guide:Getting Started/Taking On Evils Protector

2026-01-06T18:49:02Z

Jamesp1989:

== Upgrading Our Gear==
{{ItemList|compact|
|
Now that we are back up on the surface we need to further upgrade and enchant our gear to prepare for the first boss. You need to have collected at least:
*{{item|Frost Shard|48|inline=1}}
this is the minimum amount of materials required to craft:
* {{item|Frost Helmet|inline=1}} (as Im mostly melee focused but il get into more detail on that later).
* {{item|Frost Chestplate}}
* {{item|Frost Boots}}
* {{item|Frost Sword|inline=1}} (my melee weapon of choice)
}}
== Enchanting Our Gear ==
{{ItemList|compact|
|

}}

Incursion tier Armor

2026-01-06T16:45:06Z

Jamesp1989: /* Ravenlord's */

===Slime===
Endgame [[Incursion]] armor for Melee and Magic classes.
{{ArmorSetTable|Slime Helmet/Slime Hat/Slime Chestplate/Slime Boots|total=90/82|setbonus='''With Helmet:''' +30 max resilience '''With Hat:''' +250/+475 max mana (+25 per tier) +2 projectile bounces '''With Any:''' Press '''V''' to reduce all damage you take to 1 for 5 seconds, but receive considerably more knockback|images=[[File:Slime Armor Helmet Set.png]] [[File:Slime Armor Hat Set.png]]}}

===Nightsteel===
Endgame [[Incursion]] armor for all classes, higher defense but less offense for melee and mage classes compared to Slime Armor Set.
{{ArmorSetTable|Nightsteel Helmet/Nightsteel Mask/Nightsteel Veil/Nightsteel Circlet/Nightsteel Chestplate/Nightsteel Boots|total=90/84/82/77|setbonus='''With Helmet:''' +30 max resilience +30% resilience gain '''With Veil:''' +250/+475 max mana (+25 per tier) '''With Circlet:''' +2 max summons '''With Any:''' Press '''V''' to get a boost and become untargetable, but cannot attack for 3 seconds|images=[[File:Nightsteel Armor Helmet Set.png]] [[File:Nightsteel Armor Mask Set.png]] [[File:Nightsteel Armor Veil Set.png]] [[File:Nightsteel Armor Circlet Set.png]]}}

===Spiderite===
Endgame [[Incursion]] armor for all classes.
{{ArmorSetTable|Spiderite Helmet/Spiderite Hood/Spiderite Hat/Spiderite Crown/Spiderite Chestplate/Spiderite Greaves|total=90/84/82/77|setbonus='''With Helmet:''' +20 max resilience +50% resilience gain '''With Hat:''' +250/+475 max mana (+25 per tier) '''With Crown:''' +2 max summons '''With Any:''' Press '''V''' to manifest a line of toxic webs for 10 seconds, 60 seconds cooldown Grants immunity to slows|images=[[File:Spiderite Armor Helmet Set.png]] [[File:Spiderite Armor Hood Set.png]] [[File:Spiderite Armor Hat Set.png]] [[File:Spiderite Armor Crown Set.png]]}}

===Dusk===
Endgame [[Incursion]] armor for Magic and Summoner classes. Has the same base defense of its Dawn counterpart.

Characters with a full set glow at night.

{{ArmorSetTable|Dusk Helmet/Dusk Chestplate/Dusk Boots|total=90|setbonus=+400 max mana Modifies Magic and Summon attacks during nighttime ''(19:00 to 7:00)'' '''Magic:''' Shoots 5 homing Moonlit Bolts in random directions '''Summon:''' Summons 1 small Moon with each summoning that lasts for 5 seconds and flies toward the target, dealing close-range damage ''(Maximum of 10 due to lifespan)''|images='''During Day''' [[File:Dusk Armor Set.png|center]] '''During Night''' [[File:Dusk Armor Set Night.png|center]]}}

===Dawn===
Endgame [[Incursion]] armor for Melee and Ranged classes. Has the same base defense of its Dusk counterpart.
{{ArmorSetTable|Dawn Helmet/Dawn Chestplate/Dawn Boots|total=90|setbonus=Modifies Melee and Ranged attacks during daytime ''(7:00 to 19:00)'' '''Melee:''' Engulfs you in flames, exploding and applying Burning for 5 seconds '''Ranged:''' Shoots 2 Flame Orbs diagonally that pass through walls and applies burning for 10 seconds|images='''During Day''' [[File:Dawn Armor Set.png|center]] '''During Night''' [[File:Dawn Armor Set Night.png|center]]}}

===Crystal===
Endgame [[Incursion]] armor for all classes.
{{ArmorSetTable|Amethyst Helmet/Sapphire Eyepatch/Emerald Mask/Ruby Crown/Crystal Chestplate/Crystal Boots|total=90|setbonus='''With Helmet:''' Deal 1% increased damage per 10 max resilience '''With Eyepatch:''' Press '''V''' to increase resilience regeneration by 250% for 5 seconds, 45 seconds cooldown '''With Mask:''' You deal 50% more (magic) damage, but take 25% more damage as well '''With Crown:''' Increase max summons by 1 per 150 max resilience|images=[[File:Crystal Armor Amethyst Set.png|center]] [[File:Crystal Armor Sapphire Set.png|center]] [[File:Crystal Armor Emerald Set.png|center]] [[File:Crystal Armor Ruby Set.png|center]]}}

===Battle Chef's===
{{ArmorSetTable|Battle Chef's Hat/Battle Chef's Chestplate/Battle Chef's Boots|total=90|setbonus=You can now be affected by one more food buff at the same time|images=.}}

===Ravenlord's===
Endgame [[Incursion]] armor for all classes. Fastest movement speed.
{{ArmorSetTable|Ravenlord's Headdress/Ravenlord's Chestplate/Ravenlord's Boots|total=90|setbonus= Feathers spawn when moving, homing in on enemies and dealing damage based on your movement speed|images='''When Stationary:''' [[File:Ravenlords Armor Set Stationary.png]] '''When Moving:''' [[File:Ravenlords Armor Set Moving.png]]}}

===Arcanic===
Endgame Incursion armor for mages.
{{ArmorSetTable|Arcanic Helmet/Arcanic Chestplate/Arcanic Boots|total=90|setbonus=Press '''V''' to become Overcharged While Overcharged, you drain 0.75% of your max mana every second, but also gain 2 stacks of Overcharged Mana for every point of mana lost When you reach 20 stacks of Overcharged Mana, fire powerful lightning at nearby enemies}}

User:Jamesp1989

2026-01-06T16:42:56Z

Jamesp1989:

[[{{FULLPAGENAME}}/LODRAFT]]

{{#if:{{#invoke:NecesseRecipes|getRecipesOld|@armoritem@}}|{{#vardefine:$hasrecipes|1}}}}

User:Jamesp1989

2026-01-06T16:39:50Z

Jamesp1989:

[[{{FULLPAGENAME}}/LODRAFT]]
{{#invoke:NecesseRecipes|getRecipesOld|"ravenlordsheaddress"}}

User:Jamesp1989

2026-01-06T16:38:54Z

Jamesp1989:

[[{{FULLPAGENAME}}/LODRAFT]]
#invoke:NecesseRecipes|getRecipesOld|"Ravenlords Headdress"

Incursion tier Armor

2026-01-02T20:55:14Z

Jamesp1989: Created page with " ===Slime=== Endgame Incursion armor for Melee and Magic classes. {{ArmorSetTable|Slime Helmet/Slime Hat/Slime Chestplate/Slime Boots|total=90/82|setbonus='''With Helmet:''' +30 max resilience '''With Hat:''' +250/+475 max mana (+25 per tier) +2 projectile bounces '''With Any:''' Press '''V''' to reduce all damage you take to 1 for 5 seconds, but receive considerably more knockback|images=File:Slime Armor Helmet Set.png File:S..."

===Slime===
Endgame [[Incursion]] armor for Melee and Magic classes.
{{ArmorSetTable|Slime Helmet/Slime Hat/Slime Chestplate/Slime Boots|total=90/82|setbonus='''With Helmet:''' +30 max resilience '''With Hat:''' +250/+475 max mana (+25 per tier) +2 projectile bounces '''With Any:''' Press '''V''' to reduce all damage you take to 1 for 5 seconds, but receive considerably more knockback|images=[[File:Slime Armor Helmet Set.png]] [[File:Slime Armor Hat Set.png]]}}

===Nightsteel===
Endgame [[Incursion]] armor for all classes, higher defense but less offense for melee and mage classes compared to Slime Armor Set.
{{ArmorSetTable|Nightsteel Helmet/Nightsteel Mask/Nightsteel Veil/Nightsteel Circlet/Nightsteel Chestplate/Nightsteel Boots|total=90/84/82/77|setbonus='''With Helmet:''' +30 max resilience +30% resilience gain '''With Veil:''' +250/+475 max mana (+25 per tier) '''With Circlet:''' +2 max summons '''With Any:''' Press '''V''' to get a boost and become untargetable, but cannot attack for 3 seconds|images=[[File:Nightsteel Armor Helmet Set.png]] [[File:Nightsteel Armor Mask Set.png]] [[File:Nightsteel Armor Veil Set.png]] [[File:Nightsteel Armor Circlet Set.png]]}}

===Spiderite===
Endgame [[Incursion]] armor for all classes.
{{ArmorSetTable|Spiderite Helmet/Spiderite Hood/Spiderite Hat/Spiderite Crown/Spiderite Chestplate/Spiderite Greaves|total=90/84/82/77|setbonus='''With Helmet:''' +20 max resilience +50% resilience gain '''With Hat:''' +250/+475 max mana (+25 per tier) '''With Crown:''' +2 max summons '''With Any:''' Press '''V''' to manifest a line of toxic webs for 10 seconds, 60 seconds cooldown Grants immunity to slows|images=[[File:Spiderite Armor Helmet Set.png]] [[File:Spiderite Armor Hood Set.png]] [[File:Spiderite Armor Hat Set.png]] [[File:Spiderite Armor Crown Set.png]]}}

===Dusk===
Endgame [[Incursion]] armor for Magic and Summoner classes. Has the same base defense of its Dawn counterpart.

Characters with a full set glow at night.

{{ArmorSetTable|Dusk Helmet/Dusk Chestplate/Dusk Boots|total=90|setbonus=+400 max mana Modifies Magic and Summon attacks during nighttime ''(19:00 to 7:00)'' '''Magic:''' Shoots 5 homing Moonlit Bolts in random directions '''Summon:''' Summons 1 small Moon with each summoning that lasts for 5 seconds and flies toward the target, dealing close-range damage ''(Maximum of 10 due to lifespan)''|images='''During Day''' [[File:Dusk Armor Set.png|center]] '''During Night''' [[File:Dusk Armor Set Night.png|center]]}}

===Dawn===
Endgame [[Incursion]] armor for Melee and Ranged classes. Has the same base defense of its Dusk counterpart.
{{ArmorSetTable|Dawn Helmet/Dawn Chestplate/Dawn Boots|total=90|setbonus=Modifies Melee and Ranged attacks during daytime ''(7:00 to 19:00)'' '''Melee:''' Engulfs you in flames, exploding and applying Burning for 5 seconds '''Ranged:''' Shoots 2 Flame Orbs diagonally that pass through walls and applies burning for 10 seconds|images='''During Day''' [[File:Dawn Armor Set.png|center]] '''During Night''' [[File:Dawn Armor Set Night.png|center]]}}

===Crystal===
Endgame [[Incursion]] armor for all classes.
{{ArmorSetTable|Amethyst Helmet/Sapphire Eyepatch/Emerald Mask/Ruby Crown/Crystal Chestplate/Crystal Boots|total=90|setbonus='''With Helmet:''' Deal 1% increased damage per 10 max resilience '''With Eyepatch:''' Press '''V''' to increase resilience regeneration by 250% for 5 seconds, 45 seconds cooldown '''With Mask:''' You deal 50% more (magic) damage, but take 25% more damage as well '''With Crown:''' Increase max summons by 1 per 150 max resilience|images=[[File:Crystal Armor Amethyst Set.png|center]] [[File:Crystal Armor Sapphire Set.png|center]] [[File:Crystal Armor Emerald Set.png|center]] [[File:Crystal Armor Ruby Set.png|center]]}}

===Battle Chef's===
{{ArmorSetTable|Battle Chef's Hat/Battle Chef's Chestplate/Battle Chef's Boots|total=90|setbonus=You can now be affected by one more food buff at the same time|images=.}}

===Ravenlord's===
Endgame [[Incursion]] armor for all classes. Fastest movement speed.
{{ArmorSetTable|Ravenlords Headdress/Ravenlords Chestplate/Ravenlords Boots|total=90|setbonus= Feathers spawn when moving, homing in on enemies and dealing damage based on your movement speed|images='''When Stationary:''' [[File:Ravenlords Armor Set Stationary.png]] '''When Moving:''' [[File:Ravenlords Armor Set Moving.png]]}}

===Arcanic===
Endgame Incursion armor for mages.
{{ArmorSetTable|Arcanic Helmet/Arcanic Chestplate/Arcanic Boots|total=90|setbonus=Press '''V''' to become Overcharged While Overcharged, you drain 0.75% of your max mana every second, but also gain 2 stacks of Overcharged Mana for every point of mana lost When you reach 20 stacks of Overcharged Mana, fire powerful lightning at nearby enemies}}

Deep Cave tier Armor

2026-01-02T20:53:00Z

Jamesp1989: Created page with " ===Tungsten=== {{ArmorSetTable|Tungsten Helmet/Tungsten Chestplate/Tungsten Boots|total=64|setbonus=+30 max resilience Knockback resistance 50% increased knockback|images=File:Tungsten Armor Set.png}} ===Shadow=== This armor is for the Ranger and Mage classes. {{ArmorSetTable|Shadow Hood/Shadow Hat/Shadow Mantle/Shadow Boots|total=46/42|setbonus='''With Hood:''' +5% crit chance +10% movement speed +15% projectile velocity +10% damage while not mov..."

===Tungsten===
{{ArmorSetTable|Tungsten Helmet/Tungsten Chestplate/Tungsten Boots|total=64|setbonus=+30 max resilience Knockback resistance 50% increased knockback|images=[[File:Tungsten Armor Set.png]]}}

===Shadow===
This armor is for the Ranger and Mage classes.
{{ArmorSetTable|Shadow Hood/Shadow Hat/Shadow Mantle/Shadow Boots|total=46/42|setbonus='''With Hood:''' +5% crit chance +10% movement speed +15% projectile velocity +10% damage while not moving '''With Hat:''' +5% movement speed +15% projectile velocity +200 max mana Magic attacks haunt target for 25 damage over 5 seconds |images=[[File:Shadow Hat Armor Set.png]] [[File:Shadow Hood Armor Set.png]]}}

===Soulseed===
{{ArmorSetTable|Soulseed Crown/Soulseed Chestplate/Soulseed Boots|total=40|setbonus=+1 max summon Press '''V''' to explode all your active summons dealing massive damage 60 seconds cooldown|images=.}}

===Glacial===
This armor is for Melee and Summoner class.
{{ArmorSetTable|Glacial Helmet/Glacial Circlet/Glacial Chestplate/Glacial Boots|total=64/44|setbonus='''With Helmet:''' +20 max resilience +20% resilience gain Melee attacks shoot out an icicle '''With Circlet:''' +1 max summons Summon attacks slow target|images=[[File:Glacial Circlet Armor Set.png|center]] [[File:Glacial Helmet Armor Set.png|center]]}}

===Deepfrost===
{{ArmorSetTable|Deepfrost Hood/Deepfrost Chestplate/Deepfrost Boots|total=56|setbonus=An animated bow will follow you and fire projectiles whenever you use a ranged weapon|images=.}}

===Cryo Witch===
This armor is for Mage and Summoner class.
{{ArmorSetTable|Cryo Witch Hat/Cryo Witch Robe/Cryo Witch Shoes|total=52|setbonus=+200 max mana Press '''V''' to encase yourself in ice while charging up a frost nova, freezing all nonhuman mobs in a large area}}

===Ninja===
{{ArmorSetTable|Ninja Hood/Ninja Robe/Ninja Shoes|total=50|setbonus='''You're a freakin' ninja!''' Removes movement speed reduction when attacking|obtained=Dropped from [[Ninja|Ninjas]] in [[Caves#Deep Snow Caves|Deep Snow Caves]]|images=[[File:Ninja Armor Set.png|center]]}}

===Dryad===
{{ArmorSetTable|Dryad Helmet/Dryad Scarf/Dryad Hat/Dryad Crown/Dryad Chestplate/Dryad Boots|total=70/60/54/50|setbonus='''With Helmet:''' 20 max resilience +20% resilience gain '''With Scarf:''' +10 armor penetration '''With Hat:''' +200 max mana '''With Crown:''' +1 max summons '''With Any:''' When out of combat, gain up to 3 Barkskin stacks which grants 10 armor each, but lose 1 stack every time you're hit.}}

===Mycelium===
This armor is for the Ranger and Summoner classes.
{{ArmorSetTable|Mycelium Hood/Mycelium Scarf/Mycelium Chestplate/Mycelium Boots|total=70/52|setbonus='''With Hood:''' Roots you to the ground and gives +100% ranged attack speed Drains stamina while holding action button '''With Scarf:''' +1 Max Summons Each hit on enemies gives +0.5% movement speed for 4.5 seconds, stacking up to 100 (50%)|images=[[File:Mycelium Hood Armor Set.png|center]] [[File:Mycelium Scarf Armor Set.png|center]]}}

===Widow===
This armor is for Mage class.
{{ArmorSetTable|Widow Helmet/Widow Chestplate/Widow Boots|total=62|setbonus=+250 max mana Attacks poison target for 25 damage over 5 seconds Grants immunity to slows|images=[[File:Widow Armor Set.png|center]]}}

===Aged Champion===
This armor is for the melee class.
{{ArmorSetTable|Aged Champion Helmet/Aged Champion Chestplate/Aged Champion Greaves|total=74|setbonus=+30 max resilience +20% resilience gain Increases melee crit chance (+20%) and gives resilience regen (+1) when at full health Blocking just before being hit greatly increases stamina regen (+200%)|images=}}

===Ancient Fossil===
{{ArmorSetTable|Ancient Fossil Helmet/Ancient Fossil Mask/Ancient Fossil Chestplate/Ancient Fossil Boots|total=80/60|setbonus='''With Helmet:''' +10 max resilience '''With Mask:''' +1 max summons '''With Any:''' Press '''V''' to gain 100% crit chance for 5 seconds 60 seconds cooldown|images=[[File:Ancient Fossil Armor Set.png|center]] [[File:Ancient Fossil Armor Mask Set.png|center]]}}

===Sharpshooter===
{{ArmorSetTable|Sharpshooter Hat/Sharpshooter Coat/Sharpshooter Boots|total=74|setbonus=Ranged hits grants a stack of Bullseye Bullseye guarantees ranged crits every 5 stacks}}

===Ancestors===
{{ArmorSetTable|Ancestors Hat/Ancestors Robe/Ancestors Boots|total=62|setbonus=+ 275 Mana Press '''V''' to manifest ghostly ancestors to fight by your side for 15 seconds 75 seconds cooldown after casting|images=.}}

Cave tier Armor

2026-01-02T20:51:06Z

Jamesp1989: Created page with "===Leather=== {{ArmorSetTable|Leather Hood/Leather Shirt/Leather Boots|total=4|setbonus=+10% attack speed|images=center}} ===Cloth=== This armor is for Mage class. {{ArmorSetTable|Cloth Hat/Cloth Robe/Cloth Boots|total=4|setbonus=+15% magic damage +30 max mana |images=center}} ===Copper=== {{ArmorSetTable|Copper Helmet/Copper Chestplate/Copper Boots|total=5(7)|setbonus=+2 armor|images=File:Copper Armor Se..."

===Leather===
{{ArmorSetTable|Leather Hood/Leather Shirt/Leather Boots|total=4|setbonus=+10% attack speed|images=[[File:Leather Armor Set.png|center]]}}

===Cloth===
This armor is for Mage class.
{{ArmorSetTable|Cloth Hat/Cloth Robe/Cloth Boots|total=4|setbonus=+15% magic damage +30 max mana |images=[[File:Cloth Armor Set.png|center]]}}

===Copper===
{{ArmorSetTable|Copper Helmet/Copper Chestplate/Copper Boots|total=5(7)|setbonus=+2 armor|images=[[File:Copper Armor Set.png|center]]}}

===Iron===
{{ArmorSetTable|Iron Helmet/Iron Chestplate/Iron Boots|total=8(10)|setbonus=+2 armor|images=[[File:Iron Armor Set.png|center]]}}

===Gold===
This set is for summoner classes (as long as you replace the gold helmet with a gold crown)
{{ArmorSetTable|Gold Helmet/Gold Crown/Gold Chestplate/Gold Boots|total=15/10|setbonus='''With Helmet:''' +2 armor '''With Crown:''' +1 max summons|images=[[File:Gold Armor Set.png|center]] [[File:Crown Armor Set.png|center]]}}

===Soldier's===
{{ArmorSetTable|Soldier's Helmet/Soldier's Cap/Soldier's Chestplate/Soldier's Boots|total=13/12|setbonus='''With Helmet:''' Gain a stacking frenzy buff when you kill an enemy Frenzy increases attack speed and movement speed '''With Cap:''' Ranged weapon projectiles ricochet to other enemies on kill}}

===Shark ===
{{ArmorSetTable|Shark Helmet/Shark Chestplate/Shark Boots|total=16|setbonus=Successful attacks bleed the target for 40 damage over 4 seconds You gain temporary movement speed and damage for every enemy bled recently}}

===Spider===
This armor is for Summoner class.
{{ArmorSetTable|Spider Helmet/Spider Chestplate/Spider Boots|total=6|setbonus=+1 max summons Attacks poison target for 10 damage over 5 seconds Grants immunity to slows|images=[[File:Spider Armor Set.png]]}}

===Frost===
This armor is for Melee, Ranger and Mage classes.
{{ArmorSetTable|Frost Helmet/Frost Hood/Frost Hat/Frost Chestplate/Frost Boots|total=21/19/19|setbonus='''With Helmet:''' Melee attacks slows and damages the target for 15 damage over 5 seconds '''With Hood:''' +10% crit chance +15% projectile velocity '''With Hat:''' +10% magic crit chance +60 max mana|images=[[File:Frost Armor Set.png|center]] [[File:Frost Hood Armor Set.png|center]] [[File:Frost Hat Armor Set.png|center]]}}

===Demonic===
{{ArmorSetTable|Demonic Helmet/Demonic Chestplate/Demonic Boots|total=19|setbonus=Press action button to sacrifice 10% of your max health Grants a buff of +15% damage +15% crit chance and +15% movement speed for 8 seconds|images=[[File:Demonic Armor Set.png|center]]}}

===Void===
This armor is for Mage and Summoner classes.
{{ArmorSetTable|Void Hat/Void Mask/Void Robe/Void Boots|total=19/15|setbonus='''With Hat:''' +100 max mana '''With Mask:''' +1 max summons '''With Either:''' Press '''V''' to gain a burst of movement speed 30 second cooldown|images=[[File:Void Hat Armor Set.png]] [[File:Void Mask Armor Set.png]]}}

===Thief's===
{{ArmorSetTable|Thief's Cowl/Thiefs's Cloak/Thief's Boots|total=18|setbonus=You have a chance to steal coins from enemies on hit Press '''V''' to throw a handful of coins at enemies 25 coins thrown, 15 seconds cooldown|images=.}}

===Bloodplate===
An early game armor set for all classes based around health regen.
{{ArmorSetTable|Bloodplate Cowl/Bloodplate Chestplate/Bloodplate Boots|total=19|setbonus=After taking damage, your health regen is doubled for 4 seconds|obtained=Can be found in [[Stone Coffin]]s in [[Mini_Biomes#Vampire_Crypt|Vampire Crypts]] ([[Caves#Forest Caves|Forest Caves]] and [[Snow#Snow Caves|Snow Caves]] biomes).|images=[[File:Bloodplate Armor Set.png|center]]}}

===Arachnid===
This armor is for Summoner class.
{{ArmorSetTable|Arachnid Helmet/Arachnid Chestplate/Arachnid Legs|total=12|setbonus=+1 max summons Spawns an additional spider summon for every third summon slot used|images=[[File:Arachnid Armor Set.png]]}}

===Runic===
This armor is for Melee, Ranger, Mage, and Summoner classes.
{{ArmorSetTable|Runic Helmet/Runic Hood/Runic Hat/Runic Crown/Runic Chestplate/Runic Boots|total=28/28/26/19|setbonus='''With Helmet, Hood, or Crown:''' +100% mana regen +10% attack speed Press '''V''' to rapidly gain damage output while mana drains '''With Hat:''' +100 max mana +50% life essence gain chance Press '''V''' to gain 3 life essence orbs 60 second cooldown}}

===Pharaoh's===
This armor is for Mage class.
{{ArmorSetTable|Pharaoh's Headdress/Pharaoh's Robe/Pharaoh's Sandals|total=34|setbonus=Periodically spawn locusts that explode on impact with enemies Spending 75 mana will also cause a locust to spawn}}

===Ivy===
This armor is for Melee, Ranger, Mage, and Summoner classes.
{{ArmorSetTable|Ivy Helmet/Ivy Hood/Ivy Hat/Ivy Circlet/Ivy Chestplate/Ivy Boots|total=41/36/35/27|setbonus='''With Helmet:''' +20 max resilience Being hit drops a poisonous goo '''With Hood:''' Attacks poison target for 15 damage over 5 seconds '''With Hat:''' +150 max mana Attacks poison target for 15 damage over 5 seconds '''With Circlet:''' +1 max summons While in combat, occasionally spawn a poison slime|images=[[File:Ivy Helmet Armor Set.png|center]] [[File:Ivy Hood Armor Set.png|center]] [[File:Ivy Hat Armor Set.png|center]] [[File:Ivy Circlet Armor Set.png|center]]}}

===Quartz===
{{ArmorSetTable|Quartz Helmet/Quartz Crown/Quartz Chestplate/Quartz Boots|total=48/34|setbonus='''With Helmet:''' +10 max resilience '''With Crown:''' +1 max summons '''With Any:''' Get a burst of movement speed after being hit 10 seconds cooldown |images=[[File:Quartz Helmet Armor Set.png|center]] [[File:Quartz Crown Armor Set.png|center]]}}

===Gunslinger===
{{ArmorSetTable|Gunslinger Hat/Gunslinger Vest/Gunslinger Boots|total=43|setbonus=Press '''V''' to rapidly shoot 6 bullets at surrounding enemies}}

===Witch===
Dropped from Evil Witch and sold by Friendly Witch after defeating an Evil Witch.
{{ArmorSetTable|Witch Hat/Witch Robe/Witch Shoes|total=36|setbonus=+150 max mana Being hit sometimes slows the attacker and spawns a charging baby crawling zombie}}

{{Collapse bottom}}

Armor

2026-01-02T20:49:33Z

Jamesp1989: preparation for splitting up the armor pages

'''Armor''' can be equipped by the player, [[Settlers]], and [[Raiders]]. Equipping armor reduces the damage taken from hits. Each point of armor reduces damage taken by 0.5 health.

Equipping a full set of matching armor will give a 'set bonus'.

Armor pieces must be equipped in the armor slots to get their benefits, equipping them in the cosmetic slots does not provide any defense.

'''Note :''' Once the player unlocks [[Incursions]], all armor pieces can be upgraded at an [[Upgrade Station]] to reach a similar level of defenses and stat bonuses. Meaning that, without considering the unique set bonus, even a weak early game armor can be relevant for end game content. 

== [[Cave tier Armor]] ==
{{Collapse top}}

===Leather===
{{ArmorSetTable|Leather Hood/Leather Shirt/Leather Boots|total=4|setbonus=+10% attack speed|images=[[File:Leather Armor Set.png|center]]}}

===Cloth===
This armor is for Mage class.
{{ArmorSetTable|Cloth Hat/Cloth Robe/Cloth Boots|total=4|setbonus=+15% magic damage +30 max mana |images=[[File:Cloth Armor Set.png|center]]}}

===Copper===
{{ArmorSetTable|Copper Helmet/Copper Chestplate/Copper Boots|total=5(7)|setbonus=+2 armor|images=[[File:Copper Armor Set.png|center]]}}

===Iron===
{{ArmorSetTable|Iron Helmet/Iron Chestplate/Iron Boots|total=8(10)|setbonus=+2 armor|images=[[File:Iron Armor Set.png|center]]}}

===Gold===
This set is for summoner classes (as long as you replace the gold helmet with a gold crown)
{{ArmorSetTable|Gold Helmet/Gold Crown/Gold Chestplate/Gold Boots|total=15/10|setbonus='''With Helmet:''' +2 armor '''With Crown:''' +1 max summons|images=[[File:Gold Armor Set.png|center]] [[File:Crown Armor Set.png|center]]}}

===Soldier's===
{{ArmorSetTable|Soldier's Helmet/Soldier's Cap/Soldier's Chestplate/Soldier's Boots|total=13/12|setbonus='''With Helmet:''' Gain a stacking frenzy buff when you kill an enemy Frenzy increases attack speed and movement speed '''With Cap:''' Ranged weapon projectiles ricochet to other enemies on kill}}

===Shark ===
{{ArmorSetTable|Shark Helmet/Shark Chestplate/Shark Boots|total=16|setbonus=Successful attacks bleed the target for 40 damage over 4 seconds You gain temporary movement speed and damage for every enemy bled recently}}

===Spider===
This armor is for Summoner class.
{{ArmorSetTable|Spider Helmet/Spider Chestplate/Spider Boots|total=6|setbonus=+1 max summons Attacks poison target for 10 damage over 5 seconds Grants immunity to slows|images=[[File:Spider Armor Set.png]]}}

===Frost===
This armor is for Melee, Ranger and Mage classes.
{{ArmorSetTable|Frost Helmet/Frost Hood/Frost Hat/Frost Chestplate/Frost Boots|total=21/19/19|setbonus='''With Helmet:''' Melee attacks slows and damages the target for 15 damage over 5 seconds '''With Hood:''' +10% crit chance +15% projectile velocity '''With Hat:''' +10% magic crit chance +60 max mana|images=[[File:Frost Armor Set.png|center]] [[File:Frost Hood Armor Set.png|center]] [[File:Frost Hat Armor Set.png|center]]}}

===Demonic===
{{ArmorSetTable|Demonic Helmet/Demonic Chestplate/Demonic Boots|total=19|setbonus=Press action button to sacrifice 10% of your max health Grants a buff of +15% damage +15% crit chance and +15% movement speed for 8 seconds|images=[[File:Demonic Armor Set.png|center]]}}

===Void===
This armor is for Mage and Summoner classes.
{{ArmorSetTable|Void Hat/Void Mask/Void Robe/Void Boots|total=19/15|setbonus='''With Hat:''' +100 max mana '''With Mask:''' +1 max summons '''With Either:''' Press '''V''' to gain a burst of movement speed 30 second cooldown|images=[[File:Void Hat Armor Set.png]] [[File:Void Mask Armor Set.png]]}}

===Thief's===
{{ArmorSetTable|Thief's Cowl/Thiefs's Cloak/Thief's Boots|total=18|setbonus=You have a chance to steal coins from enemies on hit Press '''V''' to throw a handful of coins at enemies 25 coins thrown, 15 seconds cooldown|images=.}}

===Bloodplate===
An early game armor set for all classes based around health regen.
{{ArmorSetTable|Bloodplate Cowl/Bloodplate Chestplate/Bloodplate Boots|total=19|setbonus=After taking damage, your health regen is doubled for 4 seconds|obtained=Can be found in [[Stone Coffin]]s in [[Mini_Biomes#Vampire_Crypt|Vampire Crypts]] ([[Caves#Forest Caves|Forest Caves]] and [[Snow#Snow Caves|Snow Caves]] biomes).|images=[[File:Bloodplate Armor Set.png|center]]}}

===Arachnid===
This armor is for Summoner class.
{{ArmorSetTable|Arachnid Helmet/Arachnid Chestplate/Arachnid Legs|total=12|setbonus=+1 max summons Spawns an additional spider summon for every third summon slot used|images=[[File:Arachnid Armor Set.png]]}}

===Runic===
This armor is for Melee, Ranger, Mage, and Summoner classes.
{{ArmorSetTable|Runic Helmet/Runic Hood/Runic Hat/Runic Crown/Runic Chestplate/Runic Boots|total=28/28/26/19|setbonus='''With Helmet, Hood, or Crown:''' +100% mana regen +10% attack speed Press '''V''' to rapidly gain damage output while mana drains '''With Hat:''' +100 max mana +50% life essence gain chance Press '''V''' to gain 3 life essence orbs 60 second cooldown}}

===Pharaoh's===
This armor is for Mage class.
{{ArmorSetTable|Pharaoh's Headdress/Pharaoh's Robe/Pharaoh's Sandals|total=34|setbonus=Periodically spawn locusts that explode on impact with enemies Spending 75 mana will also cause a locust to spawn}}

===Ivy===
This armor is for Melee, Ranger, Mage, and Summoner classes.
{{ArmorSetTable|Ivy Helmet/Ivy Hood/Ivy Hat/Ivy Circlet/Ivy Chestplate/Ivy Boots|total=41/36/35/27|setbonus='''With Helmet:''' +20 max resilience Being hit drops a poisonous goo '''With Hood:''' Attacks poison target for 15 damage over 5 seconds '''With Hat:''' +150 max mana Attacks poison target for 15 damage over 5 seconds '''With Circlet:''' +1 max summons While in combat, occasionally spawn a poison slime|images=[[File:Ivy Helmet Armor Set.png|center]] [[File:Ivy Hood Armor Set.png|center]] [[File:Ivy Hat Armor Set.png|center]] [[File:Ivy Circlet Armor Set.png|center]]}}

===Quartz===
{{ArmorSetTable|Quartz Helmet/Quartz Crown/Quartz Chestplate/Quartz Boots|total=48/34|setbonus='''With Helmet:''' +10 max resilience '''With Crown:''' +1 max summons '''With Any:''' Get a burst of movement speed after being hit 10 seconds cooldown |images=[[File:Quartz Helmet Armor Set.png|center]] [[File:Quartz Crown Armor Set.png|center]]}}

===Gunslinger===
{{ArmorSetTable|Gunslinger Hat/Gunslinger Vest/Gunslinger Boots|total=43|setbonus=Press '''V''' to rapidly shoot 6 bullets at surrounding enemies}}

===Witch===
Dropped from Evil Witch and sold by Friendly Witch after defeating an Evil Witch.
{{ArmorSetTable|Witch Hat/Witch Robe/Witch Shoes|total=36|setbonus=+150 max mana Being hit sometimes slows the attacker and spawns a charging baby crawling zombie}}

{{Collapse bottom}}

== [[Deep Cave tier Armor]] ==
{{Collapse top}}

===Tungsten===
{{ArmorSetTable|Tungsten Helmet/Tungsten Chestplate/Tungsten Boots|total=64|setbonus=+30 max resilience Knockback resistance 50% increased knockback|images=[[File:Tungsten Armor Set.png]]}}

===Shadow===
This armor is for the Ranger and Mage classes.
{{ArmorSetTable|Shadow Hood/Shadow Hat/Shadow Mantle/Shadow Boots|total=46/42|setbonus='''With Hood:''' +5% crit chance +10% movement speed +15% projectile velocity +10% damage while not moving '''With Hat:''' +5% movement speed +15% projectile velocity +200 max mana Magic attacks haunt target for 25 damage over 5 seconds |images=[[File:Shadow Hat Armor Set.png]] [[File:Shadow Hood Armor Set.png]]}}

===Soulseed===
{{ArmorSetTable|Soulseed Crown/Soulseed Chestplate/Soulseed Boots|total=40|setbonus=+1 max summon Press '''V''' to explode all your active summons dealing massive damage 60 seconds cooldown|images=.}}

===Glacial===
This armor is for Melee and Summoner class.
{{ArmorSetTable|Glacial Helmet/Glacial Circlet/Glacial Chestplate/Glacial Boots|total=64/44|setbonus='''With Helmet:''' +20 max resilience +20% resilience gain Melee attacks shoot out an icicle '''With Circlet:''' +1 max summons Summon attacks slow target|images=[[File:Glacial Circlet Armor Set.png|center]] [[File:Glacial Helmet Armor Set.png|center]]}}

===Deepfrost===
{{ArmorSetTable|Deepfrost Hood/Deepfrost Chestplate/Deepfrost Boots|total=56|setbonus=An animated bow will follow you and fire projectiles whenever you use a ranged weapon|images=.}}

===Cryo Witch===
This armor is for Mage and Summoner class.
{{ArmorSetTable|Cryo Witch Hat/Cryo Witch Robe/Cryo Witch Shoes|total=52|setbonus=+200 max mana Press '''V''' to encase yourself in ice while charging up a frost nova, freezing all nonhuman mobs in a large area}}

===Ninja===
{{ArmorSetTable|Ninja Hood/Ninja Robe/Ninja Shoes|total=50|setbonus='''You're a freakin' ninja!''' Removes movement speed reduction when attacking|obtained=Dropped from [[Ninja|Ninjas]] in [[Caves#Deep Snow Caves|Deep Snow Caves]]|images=[[File:Ninja Armor Set.png|center]]}}

===Dryad===
{{ArmorSetTable|Dryad Helmet/Dryad Scarf/Dryad Hat/Dryad Crown/Dryad Chestplate/Dryad Boots|total=70/60/54/50|setbonus='''With Helmet:''' 20 max resilience +20% resilience gain '''With Scarf:''' +10 armor penetration '''With Hat:''' +200 max mana '''With Crown:''' +1 max summons '''With Any:''' When out of combat, gain up to 3 Barkskin stacks which grants 10 armor each, but lose 1 stack every time you're hit.}}

===Mycelium===
This armor is for the Ranger and Summoner classes.
{{ArmorSetTable|Mycelium Hood/Mycelium Scarf/Mycelium Chestplate/Mycelium Boots|total=70/52|setbonus='''With Hood:''' Roots you to the ground and gives +100% ranged attack speed Drains stamina while holding action button '''With Scarf:''' +1 Max Summons Each hit on enemies gives +0.5% movement speed for 4.5 seconds, stacking up to 100 (50%)|images=[[File:Mycelium Hood Armor Set.png|center]] [[File:Mycelium Scarf Armor Set.png|center]]}}

===Widow===
This armor is for Mage class.
{{ArmorSetTable|Widow Helmet/Widow Chestplate/Widow Boots|total=62|setbonus=+250 max mana Attacks poison target for 25 damage over 5 seconds Grants immunity to slows|images=[[File:Widow Armor Set.png|center]]}}

===Aged Champion===
This armor is for the melee class.
{{ArmorSetTable|Aged Champion Helmet/Aged Champion Chestplate/Aged Champion Greaves|total=74|setbonus=+30 max resilience +20% resilience gain Increases melee crit chance (+20%) and gives resilience regen (+1) when at full health Blocking just before being hit greatly increases stamina regen (+200%)|images=}}

===Ancient Fossil===
{{ArmorSetTable|Ancient Fossil Helmet/Ancient Fossil Mask/Ancient Fossil Chestplate/Ancient Fossil Boots|total=80/60|setbonus='''With Helmet:''' +10 max resilience '''With Mask:''' +1 max summons '''With Any:''' Press '''V''' to gain 100% crit chance for 5 seconds 60 seconds cooldown|images=[[File:Ancient Fossil Armor Set.png|center]] [[File:Ancient Fossil Armor Mask Set.png|center]]}}

===Sharpshooter===
{{ArmorSetTable|Sharpshooter Hat/Sharpshooter Coat/Sharpshooter Boots|total=74|setbonus=Ranged hits grants a stack of Bullseye Bullseye guarantees ranged crits every 5 stacks}}

===Ancestors===
{{ArmorSetTable|Ancestors Hat/Ancestors Robe/Ancestors Boots|total=62|setbonus=+ 275 Mana Press '''V''' to manifest ghostly ancestors to fight by your side for 15 seconds 75 seconds cooldown after casting|images=.}}

{{Collapse bottom}}

== [[Incursion tier Armor]] ==
{{Collapse top}}

===Slime===
Endgame [[Incursion]] armor for Melee and Magic classes.
{{ArmorSetTable|Slime Helmet/Slime Hat/Slime Chestplate/Slime Boots|total=90/82|setbonus='''With Helmet:''' +30 max resilience '''With Hat:''' +250/+475 max mana (+25 per tier) +2 projectile bounces '''With Any:''' Press '''V''' to reduce all damage you take to 1 for 5 seconds, but receive considerably more knockback|images=[[File:Slime Armor Helmet Set.png]] [[File:Slime Armor Hat Set.png]]}}

===Nightsteel===
Endgame [[Incursion]] armor for all classes, higher defense but less offense for melee and mage classes compared to Slime Armor Set.
{{ArmorSetTable|Nightsteel Helmet/Nightsteel Mask/Nightsteel Veil/Nightsteel Circlet/Nightsteel Chestplate/Nightsteel Boots|total=90/84/82/77|setbonus='''With Helmet:''' +30 max resilience +30% resilience gain '''With Veil:''' +250/+475 max mana (+25 per tier) '''With Circlet:''' +2 max summons '''With Any:''' Press '''V''' to get a boost and become untargetable, but cannot attack for 3 seconds|images=[[File:Nightsteel Armor Helmet Set.png]] [[File:Nightsteel Armor Mask Set.png]] [[File:Nightsteel Armor Veil Set.png]] [[File:Nightsteel Armor Circlet Set.png]]}}

===Spiderite===
Endgame [[Incursion]] armor for all classes.
{{ArmorSetTable|Spiderite Helmet/Spiderite Hood/Spiderite Hat/Spiderite Crown/Spiderite Chestplate/Spiderite Greaves|total=90/84/82/77|setbonus='''With Helmet:''' +20 max resilience +50% resilience gain '''With Hat:''' +250/+475 max mana (+25 per tier) '''With Crown:''' +2 max summons '''With Any:''' Press '''V''' to manifest a line of toxic webs for 10 seconds, 60 seconds cooldown Grants immunity to slows|images=[[File:Spiderite Armor Helmet Set.png]] [[File:Spiderite Armor Hood Set.png]] [[File:Spiderite Armor Hat Set.png]] [[File:Spiderite Armor Crown Set.png]]}}

===Dusk===
Endgame [[Incursion]] armor for Magic and Summoner classes. Has the same base defense of its Dawn counterpart.

Characters with a full set glow at night.

{{ArmorSetTable|Dusk Helmet/Dusk Chestplate/Dusk Boots|total=90|setbonus=+400 max mana Modifies Magic and Summon attacks during nighttime ''(19:00 to 7:00)'' '''Magic:''' Shoots 5 homing Moonlit Bolts in random directions '''Summon:''' Summons 1 small Moon with each summoning that lasts for 5 seconds and flies toward the target, dealing close-range damage ''(Maximum of 10 due to lifespan)''|images='''During Day''' [[File:Dusk Armor Set.png|center]] '''During Night''' [[File:Dusk Armor Set Night.png|center]]}}

===Dawn===
Endgame [[Incursion]] armor for Melee and Ranged classes. Has the same base defense of its Dusk counterpart.
{{ArmorSetTable|Dawn Helmet/Dawn Chestplate/Dawn Boots|total=90|setbonus=Modifies Melee and Ranged attacks during daytime ''(7:00 to 19:00)'' '''Melee:''' Engulfs you in flames, exploding and applying Burning for 5 seconds '''Ranged:''' Shoots 2 Flame Orbs diagonally that pass through walls and applies burning for 10 seconds|images='''During Day''' [[File:Dawn Armor Set.png|center]] '''During Night''' [[File:Dawn Armor Set Night.png|center]]}}

===Crystal===
Endgame [[Incursion]] armor for all classes.
{{ArmorSetTable|Amethyst Helmet/Sapphire Eyepatch/Emerald Mask/Ruby Crown/Crystal Chestplate/Crystal Boots|total=90|setbonus='''With Helmet:''' Deal 1% increased damage per 10 max resilience '''With Eyepatch:''' Press '''V''' to increase resilience regeneration by 250% for 5 seconds, 45 seconds cooldown '''With Mask:''' You deal 50% more (magic) damage, but take 25% more damage as well '''With Crown:''' Increase max summons by 1 per 150 max resilience|images=[[File:Crystal Armor Amethyst Set.png|center]] [[File:Crystal Armor Sapphire Set.png|center]] [[File:Crystal Armor Emerald Set.png|center]] [[File:Crystal Armor Ruby Set.png|center]]}}

===Battle Chef's===
{{ArmorSetTable|Battle Chef's Hat/Battle Chef's Chestplate/Battle Chef's Boots|total=90|setbonus=You can now be affected by one more food buff at the same time|images=.}}

===Ravenlord's===
Endgame [[Incursion]] armor for all classes. Fastest movement speed.
{{ArmorSetTable|Ravenlords Headdress/Ravenlords Chestplate/Ravenlords Boots|total=90|setbonus= Feathers spawn when moving, homing in on enemies and dealing damage based on your movement speed|images='''When Stationary:''' [[File:Ravenlords Armor Set Stationary.png]] '''When Moving:''' [[File:Ravenlords Armor Set Moving.png]]}}

===Arcanic===
Endgame Incursion armor for mages.
{{ArmorSetTable|Arcanic Helmet/Arcanic Chestplate/Arcanic Boots|total=90|setbonus=Press '''V''' to become Overcharged While Overcharged, you drain 0.75% of your max mana every second, but also gain 2 stacks of Overcharged Mana for every point of mana lost When you reach 20 stacks of Overcharged Mana, fire powerful lightning at nearby enemies}}

{{Collapse bottom}}
.

Guide:Getting Started/Upgrading Your Gear

2025-12-31T03:32:28Z

Jamesp1989: /* Using your Forge */

==Upgrading your gear==
===Making a Forge===
{{ItemList|compact|
|Now that we are back on the surface i'm sure you are wanting to reap the rewards of your adventure. go ahead and open the {{Item|Workstation|inline=1}} and craft a {{Item|Forge|inline=1}}. To do this you will need: 
* {{Item|Stone|20}}
You should have more than enough from your time in the caves. Go ahead and craft it and then place it where you want.
}}
===Using your Forge===
{{ItemList|compact|
|Now that you have placed your forge you should place your mouse over it and right click. you will get the following window pop up: 
[[File:Forgeui.png|500px]] 
you will notice that there is a space for fuel which is required to use the forge. if you followed along with me you should have a bunch of trees around the elders house you can chop down for fuel. place some [[Logs]] in and you are ready to use the forge. 
Take your ores that you obtained down in the caves and place them in the two slots on the left inside the forge, Bars will appear on the right hand side of the forge over time till it runs out of ore or fuel 

{{tip|tip|It takes 4 ore to make one bar, but if you happened to find any {{Item|Broken Copper Tool|inline =1}} or {{Item|Broken Iron Tool|inline=1}} they can be put in the forge and only costs 1 of them to make the respective bar}}

[[File:Forgerunning.gif|500px]]
{{tip|tip|If you put 2 different ores in the 2 slots available it will process the ore on the right first}}
}}

===Making an Iron Anvil===
{{ItemList|compact|
|
The next thing we need is an {{Item|Iron Anvil|inline=1}} which is crafted with:
* {{Item|Iron Bar|5}}
Once you have made one place it where you like. we are finally ready to craft some [[Equipment]]
}}
===Crafting Equipment===
{{ItemList|compact|
|
Head over to your anvil and you should see something like this: 
[[File:Anvilui.png|500px]] 
{{tip|tip|there is a tick box down on the bottom left that says "Use nearby inventories" if this is left ticked you can use items from nearby {{Item|Storagebox|inline=1}} instead of having to have the items in your inventory}}}}
====Armor and Weapons upgrade loop====
{{ItemList|compact|
|
now we need to go back to our {{Item|Forge|inline=1}} with all the ores we have from our first trip down in the caves and smelt everything we have currently. right now you will likely have mostly
* {{item|Copper Ore|inline=1}}
* {{item|Iron Ore|inline=1}}
so smelt them down to bars and then head over to the {{item|Iron Anvil|inline=1}} to make some armor 
{{tip|tip|Different [[Armor]] have different set perks which are usually geared towards the different fighting styles in the game. 

The style you want will usually depend on what your [[Weapon]] of choice is. and we will go more into the what the different styles are good at later.}}
For now you just want to make the best armor you can so go over and take a look at the anvil.

take a look at the pieces for the armor in the {{item|Iron Anvil|inline=1}} and it will tell you how much of each material you need to craft it. in the case of copper equipment you need:
}}
{| class="wikitable"
|+ Copper Gear
|-
! Header text !! Header text
|-
| {{item|Copper Bar|inline=1|12}} || {{item|Copper Helmet}}
|-
| {{item|Copper Bar|inline=1}|16}} || {{item|Copper Chestplate}}
|-
| {{item|Copper Bar|inline=1|8}} || {{item|Copper Boots}}
|-
| {{item|Copper Bar|8}}{{item|Any Log|1}} || {{item|Copper Pickaxe}}
|-
| {{item|Copper Bar|10}}{{item|Any Log|1}} || {{item|Copper Sword}}
|}
{{tip|tip|This is not an extensive list of what you can make with these bars. you can go right to making iron equipment if you have enough resources}}{{ItemList|compact|
|The idea is to do this with the best equipment you can currently craft and then head back down to the caves and repeat the process of gathering materials 
Once you have a full set of Copper Equipment you should try to move to making Iron equipment and finally Gold equipment.
}}
===Enchanting your gear===
{{ItemList|compact|
|
enchanting your gear is very important to give yourself that extra edge. at this point in the game you only have access to enchanting via {{item|Enchanting Scroll|inline=1}} which you will hopefully have found some while down in the caves! Each enchanting scroll is for a specific type of equipment and the description when you hover over the scroll will let you know what it is for. you right click on the scroll you want to use and then drag the piece of equipment you want to enchant into the slot and then press the enchant button.
{{tip|note|the scroll item is one time use and you will lose it on use but equipment can have its enchantment changed as often as you like}}
[[File:Enchanting.gif|300px]] 

In this instance i applied the Sturdy enchantment to my armor giving it an aditional +4 armor.
}}
===To The Snow Biome===
{{tip|tip|This was my build before entering the [[Caves|Snow Caves]]. you can mouse over the different pieces of gear to see what they are and mouse over the [[File:Enchantingscroll_equipment.png]] icon to see what they were enchanted with}}
{{NecesseBuild
|trinket1=Fuzzy Dice
|trinket1_enchant=Precise(+4% Crit Chance)
|trinket2=Zephyr Charm
|trinket3=Shine Belt
|trinket3_enchant=Sturdy(+4 Armor)
|trinket4=Noble Horseshoe
|trinket4_enchant=Nimble(+4% Movement speed)

|cosmetic_hat=
|cosmetic_chest=
|cosmetic_feet=
|ability_trinket=Leather Dashers
|ability_trinket_enchant=Quick(+4% Attack Speed)

|armor_head=Gold Helmet
|armor_head_enchant=Sturdy(+4 Armor)
|armor_chest=Gold Chestplate
|armor_chest_enchant=Sturdy(+4 Armor)
|armor_feet=Gold Boots
|armor_feet_enchant=Sturdy(+4 Armor)
|mount=Minecart
|hotbar1=Gold Pickaxe

|hotbar2=Wood Axe

|hotbar3=Gold Sword

|hotbar4=Gold Bow
|hotbar4_qty=40

|hotbar5=Bread
|hotbar5_qty=9

|hotbar6=Blueberry
|hotbar6_qty=12

|hotbar7=Health Potion
|hotbar7_qty=5
}}
{{tip|map|there is one more ore above gold that we have access to before the first boss {{item|Frost Shard|inline=1}} which we will be needing to upgrade to but its not found here in the forest caves, so once you have full gold equipment you are ready to visit the snow biome for [[Guide:Getting Started/A Snowy Encounter|a snowy encounter]]}}

Stat Modifier

2025-12-31T03:11:55Z

Jamesp1989: /* Movement */

== Stat Modifiers ==

[[Armor]] and [[Weapons]] as well as [[Potions]],[[Food]] and even the enviroment itself such as [[Lava]] can apply positive or negative effects to the players stats

== Damage ==
{| class="wikitable"
|+ Damage Modifiers
|-
! Modifier !! Effect !! Notes
|-
| Damage || X% Damage dealt || Overall damage modifier
|-
| Melee Damage || X% Melee damage dealt || Applies to melee attacks
|-
| Ranged Damage || X% Ranged damage dealt || Applies to ranged attacks
|-
| Magic Damage || X% Magic damage dealt || Applies to magic attacks
|-
| Summon Damage || X% Summon damage dealt || Applies to summons and minions
|-
| Fire Damage || X Fire Damage || Applies damage of X per second over time.
|}

== Critical ==
{| class="wikitable"
|+ Critical Modifiers
|-
! Modifier !! Effect !! Notes
|-
| Critical Chance || X% Critical hit chance || Chance for attacks to crit
|-
| Critical Damage || X% Critical damage || Damage multiplier on critical hits
|-
| Melee Critical Damage || X% Melee critical damage || Extra crit damage for melee
|}

== Attack Speed ==
{| class="wikitable"
|+ Attack Speed Modifiers
|-
! Modifier !! Effect !! Notes
|-
| Attack Speed || X% Attack speed || Overall attack speed
|-
| Melee Attack Speed || X% Melee attack speed || Melee weapons only
|-
| Ranged Attack Speed || X% Ranged attack speed || Ranged weapons only
|-
| Magic Attack Speed || X% Magic attack speed || Magic weapons only
|-
| Summon Speed || X% Summon speed || Summon attack speed
|}

== Movement ==
{| class="wikitable"
|+ Movement Modifiers
|-
! Modifier !! Effect !! Notes
|-
| Movement Speed || X Movement speed || Player movement speed
|-
| Attack Movement Penalty || X% Attack movement penalty || Slowdown while attacking
|}

== Defense ==
{| class="wikitable"
|+ Defense Modifiers
|-
! Modifier !! Effect !! Notes
|-
| Armor || X Armor || Flat damage reduction
|-
| Damage Taken || X% Damage taken || Modifies incoming damage
|-
| Knockback Resistance || X% Knockback resistance || Reduces knockback taken
|-
| Max Knockback || X% Maximum knockback || Upper limit of knockback taken
|}

== Health ==
{| class="wikitable"
|+ Health Modifiers
|-
! Modifier !! Effect !! Notes
|-
| Max Health || X Maximum health || Total health pool
|-
| Health Regen || X Health regeneration || Health recovery rate
|-
| Max X% Health Regen || X Maximum health || How much health can regen as a percentage
|-
| Max X% Out Of Combat Health Regen || X Maximum health || How much health can regen outside of combat as a percentage
|-
|}

== Resilience ==
{| class="wikitable"
|+ Resilience Modifiers
|-
! Modifier !! Effect !! Notes
|-
| Max Resilience || X Maximum resilience || Total resilience pool
|-
| Resilience Gain || X% Resilience gain || Gained from dealing damage
|-
| Resilience Decay || X% Resilience decay || Rate resilience decreases
|-
| Resilience Regeneration || X Resilience regeneration || Passive resilience recovery
|}

== Mana ==
{| class="wikitable"
|+ Mana Modifiers
|-
! Modifier !! Effect !! Notes
|-
| Max Mana || X Maximum mana || Total mana pool
|-
| Mana Regeneration || X% Mana regeneration || Mana recovery rate
|-
| Mana Cost || X% Mana cost || Mana usage modifier
|}

== Stamina ==
{| class="wikitable"
|+ Stamina Modifiers
|-
! Modifier !! Effect !! Notes
|-
| Stamina Regeneration || X% Stamina regeneration || Stamina recovery rate
|-
| Stamina Cost || X% Stamina cost || Stamina usage modifier
|}

== Projectiles ==
{| class="wikitable"
|+ Projectile Modifiers
|-
! Modifier !! Effect !! Notes
|-
| Projectile Velocity || X% Projectile velocity || Projectile travel speed
|-
| Projectile Range || X% Projectile range || Projectile travel distance
|}

== Summons ==
{| class="wikitable"
|+ Summon Modifiers
|-
! Modifier !! Effect !! Notes
|-
| Max Summons || X Maximum summons || Number of active summons
|-
| Summon Target Range || X% Summon target range || Targeting distance
|}

== Utility ==
{| class="wikitable"
|+ Utility Modifiers
|-
! Modifier !! Effect !! Notes
|-
| Dash Charges || X Dash charges || Number of dash uses
|-
| Ammo Consumption || X% Ammo consumption || Chance to consume ammo
|}

Guide:Getting Started

2025-12-31T03:08:48Z

Jamesp1989: /* Food */

== Getting Started Guide ==

{{tip|tip|Welcome to the wonderful world of '''Necesse'''. This game may seem slightly overwhelming but let me reassure you, the basics of this game can be learned quite easily.}}
 

=== Joining A World For The First Time ===

When starting a new world or joining a multiplayer world for the first time you will need to create a new character we call [[The Player]].

{{Tip|note|Your character can be reused across multiple worlds, so don’t worry too much about early choices.}}
 
[[File:Create player.jpg|300px]] 

=== Your Starting Location ===

Once you load into the world I suggest you head into the house you spawn by and take a look at the
[[Guide:Getting_Started/User Interface|User Interface]] and [[Controls]] pages to familiarise yourself with them.

{{Tip|tip|Knowing your controls early will make combat and exploration much easier later on.}}
 

[[File:The Elders House.png|500px]] 
''The player's default spawn point near the Elder's House.'' 

=== Player Inventory ===
{{ItemList|compact|The player's starting inventory includes:
|
* {{Item|Wood Axe|inline=1}}
* {{Item|Wood Sword|inline=1}}
* {{Item|Crafting Guide|inline=1}}{{Tip|note|These starting tools are enough to begin gathering resources and crafting basic equipment.}}}}

[[File:The Players Starting Inventory.png|500px]] 
''Starting inventory.'' 

{{ItemList|compact|
|
== The Elders House ==
In new worlds, the player spawns in a [[Forest Biome]] next to the house of the [[Elder]], if the corresponding option was selected when creating the world.
The [[Elder]] is your game guide and [[quests]] giver. He will provide useful and sometimes unique rewards for completing quests, so don't ignore him.

{{Tip|tip|Completing the Elder’s quests is one of the easiest ways to follow intended [[Guide:Getting_Started/Progression|Progression]]}}
}}

{{ItemList|compact|
|
=== Inside the Elders House ===
In the Elder's house, the player will find a {{Item|Workstation|inline=1}} where they can craft their first equipment needed for the further exploration, such as:
* {{Item|Wood Pickaxe|inline=1}}
* {{Item|Wood Shovel|inline=1}}
* {{Item|Wood Boat|inline=1}}
* {{Item|Torches|inline=1}}
There is also a {{Item|Spruce Display|inline=1}} which holds:
* a pair of {{Item|Leather Dashers|inline=1}}
{{Tip|tip|[[Leather Dashers]] are an [[Trinkets#Ability Trinkets|Ability Trinket]] which allows the player to [[Dashing|Dash]] at the expense of [[Stamina]].
}}}} 
{{ItemList|compact|
|
==== Spawn Points and Beds ====
The Elder's {{item|Bed|inline=1}} can be used to set a spawn point inside the house. 
This is the place the player will return to when they die.
{{tip|note|You will be able to craft your own beds later.Beds can be used to skip between day and night if all players are in bed. we will go more into the day and night cycle shortly}}}}
{{ItemList|compact|
|
==== The Elder's Storagebox ====
There is a {{Item|Storagebox|inline=1}} in the elders house that the player can take items from which contains:
* {{Item|Village Map|inline=1}}
* {{Item|Dungeon Map|inline=1}}
* {{Item|Bread|inline=1}}
* {{Item|Health Potion|inline=1}}
* {{Item|Settlement Flag|inline=1}}
{{Tip|note|A [[Settlement Flag]] is used to start a [[Settlements|settlement]].
The flag can be placed on any [[terrain]] [[Tiles|tile]] outside or inside the house. Go ahead and do this now as we will need it placed later to take a quest from the elder, We will cover [[Guide:Getting_Started/Settlements|Settlements]] in more detail later in the guide}}}}
{{ItemList|compact|
|
==== Cave Ladder ====
{{Tip|warning|The elders house also has a {{Item|Cave Ladder|inline=1}} to go down into the [[Caves]] but we arent quite ready for that yet.}}
}}

{{ItemList|compact|
|
=== Outside the Elders House ===
Outside the house is a {{Item|Roasting Station|inline=1}} on top of a {{Item|Campfire|inline=1}} which you can use to cook raw meat from:
* {{Item|Cow|inline=1}}
* {{Item|Sheep|inline=1}}
and other [[Animals]]

{{Tip|note|It's best not to kill the animals near your spawn as you can use them later for [[Animals#Taming|Taming]], [[Animals#Breeding|Breeding]] and [[Animals#Harvesting|Harvesting]].}}}}

=Exploring the World=
===Day And Night Cycle===
{{tip|note|The world has a day and night cycle. in the forest nothing hostile will spawn during the day but [[Zombie]]s come out at night so be sure to take shelter or be prepared to fight }}

== Obtaining Mining Gear ==
{{ItemList|compact|Head outside of the [[elder]]s house and chop down some [[Trees]].
|
In the forest it will be either:
* {{item|Oak Tree|inline=1|size=32px}}
* {{item|Spruce Tree|inline=1|size=32px}}
{{tip|tip|You can chop trees down with the {{item|Wood Axe|inline=1}} that came in your starting inventory and collect the [[Logs]] and [[Saplings]] that drop.

You should cut down more than you need so that you can use the extra logs to craft more torches and replant the saplings near the elders house to grow over time.
}}}}
{{ItemList|compact|
|
Before We head down to the [[Caves]] we need at least:
* {{item|Oak Log|inline=1|size=32px|2}} to make a {{item|Wood Pickaxe|inline=1}}
* 10 logs and 10 saplings to make {{item|Torch|inline=1|size=32px|40}}
{{Tip|warning|Torches are essential in caves — darkness hides enemies and hazards.}}}}

{{ItemList|compact|Once you have all of these head over to the {{item|Workstation|inline=1}} inside the [[Elder]]s house and craft:
|
* {{item|Wood Pickaxe|inline=1}}
* {{item|Torch|inline=1|40}}
}}
= Food =
{{ItemList|compact|
|
{{tip|tip| Food items are very important in Necesse and not just to stave off [[Guide:Getting_Started/User_Interface#Hunger|hunger]]: not only do different food items restore your hunger by differing amounts they also all give the player buffs dependant on the food item consumed. 
Food items can be separated into Raw, Fine and Gourmet with the buffs received getting better the higher the quality of food is, but we will go into that later }}{{tip|warning|you can only have one food buff at a time and consuming another will remove the previous buff instantly}}
}}

{{ItemList|compact|
|
== Food Buffs ==
I wont go into a great deal about the different food or food buffs right now but I will cover the first few you are likely to encounter:
===[[Simple Food]]===
====Fruits ====
These are classed as simple raw foods that have a positive buff when eaten:
* {{Item|Apple|inline=1|+2% Movement Speed}}
* {{Item|Blueberry|inline=1|+2% Crit Chance}}
==== Raw Meat ====
These are raw meats. you shouldn't eat these without [[Guide:Getting_Started#Outside the Elders House|cooking them]] otherwise you will take 10 damage
* {{Item|Beef|inline=1|-10 Health}}(becomes {{Item|Steak|inline=1}} when cooked)
* {{Item|Raw Mutton|inline=1|-10 Health}}(becomes {{Item|Roasted Mutton|inline=1}} when cooked)
=== [[Fine Food]]s ===
* {{Item|Steak|inline=1|+2% Damage}}
* {{Item|Roasted Mutton|inline=1|+2% Crit Chance}}
* {{Item|Bread|inline=1|+20 Max Health}}
}}
== Food Spoilage ==

{{tip|tip|
Food in your backpack and regular {{Item|Storagebox|inline=1}} will spoil over time and different foods have their own spoil times. once this time reaches 0 it becomes {{item|Spoiled Food|inline=1}} which has its own uses which we will get into later
}}

= Final Preparations =

{{ItemList|compact|If you haven't already make sure you grab:
|
* {{item|Bread|inline=1}}
* {{item|Health Potion|inline=1}}

from the chest or:
* find some {{item|Blueberry|inline=1}} from {{item|Blueberry Bush|inline=1|size=32px}} in the surrounding forest.
{{Tip|tip|If you come across any {{item|Blueberry Bush|inline=1|size=32px}} you should break these and place them near the elders house as an early source of food.

Carrying food and healing items greatly increases your survival chances underground.}}}}
 
Your inventory should look a little like this:

{{NecesseBuild
|cosmetic_feet=Shoes
|ability_trinket=Leather Dashers

|hotbar1=Wood Pickaxe
|hotbar2=Wood Axe
|hotbar3=Wood Sword

|hotbar4=Torch
|hotbar4_qty=40

|hotbar5=Bread
|hotbar5_qty=9

|hotbar6=Blueberry
|hotbar6_qty=12

|hotbar7=Health Potion
|hotbar7_qty=5
}}

=== Down We Go ===

{{Tip|map|If you feel unsure, you can always gather more supplies before entering the caves. 
Head over to the cave ladder for
[[Guide:Getting_Started/Your_First_Cave|Your First Cave]]
when you feel comfortable you have everything you need.}}

[[Category:Guides]]

Guide:Getting Started/Upgrading Your Gear

2025-12-31T02:58:32Z

Jamesp1989: /* To The Snow Biome */

==Upgrading your gear==
===Making a Forge===
{{ItemList|compact|
|Now that we are back on the surface i'm sure you are wanting to reap the rewards of your adventure. go ahead and open the {{Item|Workstation|inline=1}} and craft a {{Item|Forge|inline=1}}. To do this you will need: 
* {{Item|Stone|20}}
You should have more than enough from your time in the caves. Go ahead and craft it and then place it where you want.
}}
===Using your Forge===
{{ItemList|compact|
|Now that you have placed your forge you should place your mouse over it and right click. you will get the following window pop up: 
[[File:Forgeui.png|500px]] 
you will notice that there is a space for fuel which is required to use the forge. if you followed along with me you should have a bunch of trees around the elders house you can chop down for fuel. place some [[Logs]] in and you are ready to use the forge. 
Take your ores that you obtained down in the caves and place them in the two slots on the left inside the forge, Bars will appear on the right hand side of the forge over time till it runs out of ore or fuel 

{{tip|tip|It takes 4 ore to make one bar, but if you happened to find any {{Item|Broken Copper Tool|inline =1}} or {{Item|Broken Iron Tool|inline=1}} they can be put in the forge and only costs 1 of them to make the respective bar}}

[[File:Forgerunning.gif|400px]]
{{tip|tip|If you put 2 different ores in the 2 slots available it will process the ore on the right first}}
}}
===Making an Iron Anvil===
{{ItemList|compact|
|
The next thing we need is an {{Item|Iron Anvil|inline=1}} which is crafted with:
* {{Item|Iron Bar|5}}
Once you have made one place it where you like. we are finally ready to craft some [[Equipment]]
}}
===Crafting Equipment===
{{ItemList|compact|
|
Head over to your anvil and you should see something like this: 
[[File:Anvilui.png|500px]] 
{{tip|tip|there is a tick box down on the bottom left that says "Use nearby inventories" if this is left ticked you can use items from nearby {{Item|Storagebox|inline=1}} instead of having to have the items in your inventory}}}}
====Armor and Weapons upgrade loop====
{{ItemList|compact|
|
now we need to go back to our {{Item|Forge|inline=1}} with all the ores we have from our first trip down in the caves and smelt everything we have currently. right now you will likely have mostly
* {{item|Copper Ore|inline=1}}
* {{item|Iron Ore|inline=1}}
so smelt them down to bars and then head over to the {{item|Iron Anvil|inline=1}} to make some armor 
{{tip|tip|Different [[Armor]] have different set perks which are usually geared towards the different fighting styles in the game. 

The style you want will usually depend on what your [[Weapon]] of choice is. and we will go more into the what the different styles are good at later.}}
For now you just want to make the best armor you can so go over and take a look at the anvil.

take a look at the pieces for the armor in the {{item|Iron Anvil|inline=1}} and it will tell you how much of each material you need to craft it. in the case of copper equipment you need:
}}
{| class="wikitable"
|+ Copper Gear
|-
! Header text !! Header text
|-
| {{item|Copper Bar|inline=1|12}} || {{item|Copper Helmet}}
|-
| {{item|Copper Bar|inline=1}|16}} || {{item|Copper Chestplate}}
|-
| {{item|Copper Bar|inline=1|8}} || {{item|Copper Boots}}
|-
| {{item|Copper Bar|8}}{{item|Any Log|1}} || {{item|Copper Pickaxe}}
|-
| {{item|Copper Bar|10}}{{item|Any Log|1}} || {{item|Copper Sword}}
|}
{{tip|tip|This is not an extensive list of what you can make with these bars. you can go right to making iron equipment if you have enough resources}}{{ItemList|compact|
|The idea is to do this with the best equipment you can currently craft and then head back down to the caves and repeat the process of gathering materials 
Once you have a full set of Copper Equipment you should try to move to making Iron equipment and finally Gold equipment.
}}
===Enchanting your gear===
{{ItemList|compact|
|
enchanting your gear is very important to give yourself that extra edge. at this point in the game you only have access to enchanting via {{item|Enchanting Scroll|inline=1}} which you will hopefully have found some while down in the caves! Each enchanting scroll is for a specific type of equipment and the description when you hover over the scroll will let you know what it is for. you right click on the scroll you want to use and then drag the piece of equipment you want to enchant into the slot and then press the enchant button.
{{tip|note|the scroll item is one time use and you will lose it on use but equipment can have its enchantment changed as often as you like}}
[[File:Enchanting.gif|300px]] 

In this instance i applied the Sturdy enchantment to my armor giving it an aditional +4 armor.
}}
===To The Snow Biome===
{{tip|tip|This was my build before entering the [[Caves|Snow Caves]]. you can mouse over the different pieces of gear to see what they are and mouse over the [[File:Enchantingscroll_equipment.png]] icon to see what they were enchanted with}}
{{NecesseBuild
|trinket1=Fuzzy Dice
|trinket1_enchant=Precise(+4% Crit Chance)
|trinket2=Zephyr Charm
|trinket3=Shine Belt
|trinket3_enchant=Sturdy(+4 Armor)
|trinket4=Noble Horseshoe
|trinket4_enchant=Nimble(+4% Movement speed)

|cosmetic_hat=
|cosmetic_chest=
|cosmetic_feet=
|ability_trinket=Leather Dashers
|ability_trinket_enchant=Quick(+4% Attack Speed)

|armor_head=Gold Helmet
|armor_head_enchant=Sturdy(+4 Armor)
|armor_chest=Gold Chestplate
|armor_chest_enchant=Sturdy(+4 Armor)
|armor_feet=Gold Boots
|armor_feet_enchant=Sturdy(+4 Armor)
|mount=Minecart
|hotbar1=Gold Pickaxe

|hotbar2=Wood Axe

|hotbar3=Gold Sword

|hotbar4=Gold Bow
|hotbar4_qty=40

|hotbar5=Bread
|hotbar5_qty=9

|hotbar6=Blueberry
|hotbar6_qty=12

|hotbar7=Health Potion
|hotbar7_qty=5
}}
{{tip|map|there is one more ore above gold that we have access to before the first boss {{item|Frost Shard|inline=1}} which we will be needing to upgrade to but its not found here in the forest caves, so once you have full gold equipment you are ready to visit the snow biome for [[Guide:Getting Started/A Snowy Encounter|a snowy encounter]]}}

Guide:Getting Started/Upgrading Your Gear

2025-12-31T02:47:30Z

Jamesp1989: /* To The Snow Biome */

==Upgrading your gear==
===Making a Forge===
{{ItemList|compact|
|Now that we are back on the surface i'm sure you are wanting to reap the rewards of your adventure. go ahead and open the {{Item|Workstation|inline=1}} and craft a {{Item|Forge|inline=1}}. To do this you will need: 
* {{Item|Stone|20}}
You should have more than enough from your time in the caves. Go ahead and craft it and then place it where you want.
}}
===Using your Forge===
{{ItemList|compact|
|Now that you have placed your forge you should place your mouse over it and right click. you will get the following window pop up: 
[[File:Forgeui.png|500px]] 
you will notice that there is a space for fuel which is required to use the forge. if you followed along with me you should have a bunch of trees around the elders house you can chop down for fuel. place some [[Logs]] in and you are ready to use the forge. 
Take your ores that you obtained down in the caves and place them in the two slots on the left inside the forge, Bars will appear on the right hand side of the forge over time till it runs out of ore or fuel 

{{tip|tip|It takes 4 ore to make one bar, but if you happened to find any {{Item|Broken Copper Tool|inline =1}} or {{Item|Broken Iron Tool|inline=1}} they can be put in the forge and only costs 1 of them to make the respective bar}}

[[File:Forgerunning.gif|400px]]
{{tip|tip|If you put 2 different ores in the 2 slots available it will process the ore on the right first}}
}}
===Making an Iron Anvil===
{{ItemList|compact|
|
The next thing we need is an {{Item|Iron Anvil|inline=1}} which is crafted with:
* {{Item|Iron Bar|5}}
Once you have made one place it where you like. we are finally ready to craft some [[Equipment]]
}}
===Crafting Equipment===
{{ItemList|compact|
|
Head over to your anvil and you should see something like this: 
[[File:Anvilui.png|500px]] 
{{tip|tip|there is a tick box down on the bottom left that says "Use nearby inventories" if this is left ticked you can use items from nearby {{Item|Storagebox|inline=1}} instead of having to have the items in your inventory}}}}
====Armor and Weapons upgrade loop====
{{ItemList|compact|
|
now we need to go back to our {{Item|Forge|inline=1}} with all the ores we have from our first trip down in the caves and smelt everything we have currently. right now you will likely have mostly
* {{item|Copper Ore|inline=1}}
* {{item|Iron Ore|inline=1}}
so smelt them down to bars and then head over to the {{item|Iron Anvil|inline=1}} to make some armor 
{{tip|tip|Different [[Armor]] have different set perks which are usually geared towards the different fighting styles in the game. 

The style you want will usually depend on what your [[Weapon]] of choice is. and we will go more into the what the different styles are good at later.}}
For now you just want to make the best armor you can so go over and take a look at the anvil.

take a look at the pieces for the armor in the {{item|Iron Anvil|inline=1}} and it will tell you how much of each material you need to craft it. in the case of copper equipment you need:
}}
{| class="wikitable"
|+ Copper Gear
|-
! Header text !! Header text
|-
| {{item|Copper Bar|inline=1|12}} || {{item|Copper Helmet}}
|-
| {{item|Copper Bar|inline=1}|16}} || {{item|Copper Chestplate}}
|-
| {{item|Copper Bar|inline=1|8}} || {{item|Copper Boots}}
|-
| {{item|Copper Bar|8}}{{item|Any Log|1}} || {{item|Copper Pickaxe}}
|-
| {{item|Copper Bar|10}}{{item|Any Log|1}} || {{item|Copper Sword}}
|}
{{tip|tip|This is not an extensive list of what you can make with these bars. you can go right to making iron equipment if you have enough resources}}{{ItemList|compact|
|The idea is to do this with the best equipment you can currently craft and then head back down to the caves and repeat the process of gathering materials 
Once you have a full set of Copper Equipment you should try to move to making Iron equipment and finally Gold equipment.
}}
===Enchanting your gear===
{{ItemList|compact|
|
enchanting your gear is very important to give yourself that extra edge. at this point in the game you only have access to enchanting via {{item|Enchanting Scroll|inline=1}} which you will hopefully have found some while down in the caves! Each enchanting scroll is for a specific type of equipment and the description when you hover over the scroll will let you know what it is for. you right click on the scroll you want to use and then drag the piece of equipment you want to enchant into the slot and then press the enchant button.
{{tip|note|the scroll item is one time use and you will lose it on use but equipment can have its enchantment changed as often as you like}}
[[File:Enchanting.gif|300px]] 

In this instance i applied the Sturdy enchantment to my armor giving it an aditional +4 armor.
}}
===To The Snow Biome===
{{tip|tip|This was my build before entering the [[Caves|Snow Caves]].}}
{{NecesseBuild
|trinket1=Fuzzy Dice
|trinket2=Zephyr Charm
|trinket3=Shine Belt
|trinket4=Noble Horseshoe

|cosmetic_hat=
|cosmetic_chest=
|cosmetic_feet=
|ability_trinket=Leather Dashers

|armor_head=Gold Helmet
|armor_chest=Gold Chestplate
|armor_feet=Gold Boots
|mount=Minecart
|hotbar1=Gold Pickaxe

|hotbar2=Wood Axe

|hotbar3=Gold Sword

|hotbar4=Gold Bow
|hotbar4_qty=40

|hotbar5=Bread
|hotbar5_qty=9

|hotbar6=Blueberry
|hotbar6_qty=12

|hotbar7=Health Potion
|hotbar7_qty=5
}}
{{tip|map|there is one more ore above gold that we have access to before the first boss {{item|Frost Shard|inline=1}} which we will be needing to upgrade to but its not found here in the forest caves, so once you have full gold equipment you are ready to visit the snow biome for [[Guide:Getting Started/A Snowy Encounter|a snowy encounter]]}}

Guide:Getting Started

2025-12-31T02:44:22Z

Jamesp1989:

== Getting Started Guide ==

{{tip|tip|Welcome to the wonderful world of '''Necesse'''. This game may seem slightly overwhelming but let me reassure you, the basics of this game can be learned quite easily.}}
 

=== Joining A World For The First Time ===

When starting a new world or joining a multiplayer world for the first time you will need to create a new character we call [[The Player]].

{{Tip|note|Your character can be reused across multiple worlds, so don’t worry too much about early choices.}}
 
[[File:Create player.jpg|300px]] 

=== Your Starting Location ===

Once you load into the world I suggest you head into the house you spawn by and take a look at the
[[Guide:Getting_Started/User Interface|User Interface]] and [[Controls]] pages to familiarise yourself with them.

{{Tip|tip|Knowing your controls early will make combat and exploration much easier later on.}}
 

[[File:The Elders House.png|500px]] 
''The player's default spawn point near the Elder's House.'' 

=== Player Inventory ===
{{ItemList|compact|The player's starting inventory includes:
|
* {{Item|Wood Axe|inline=1}}
* {{Item|Wood Sword|inline=1}}
* {{Item|Crafting Guide|inline=1}}{{Tip|note|These starting tools are enough to begin gathering resources and crafting basic equipment.}}}}

[[File:The Players Starting Inventory.png|500px]] 
''Starting inventory.'' 

{{ItemList|compact|
|
== The Elders House ==
In new worlds, the player spawns in a [[Forest Biome]] next to the house of the [[Elder]], if the corresponding option was selected when creating the world.
The [[Elder]] is your game guide and [[quests]] giver. He will provide useful and sometimes unique rewards for completing quests, so don't ignore him.

{{Tip|tip|Completing the Elder’s quests is one of the easiest ways to follow intended [[Guide:Getting_Started/Progression|Progression]]}}
}}

{{ItemList|compact|
|
=== Inside the Elders House ===
In the Elder's house, the player will find a {{Item|Workstation|inline=1}} where they can craft their first equipment needed for the further exploration, such as:
* {{Item|Wood Pickaxe|inline=1}}
* {{Item|Wood Shovel|inline=1}}
* {{Item|Wood Boat|inline=1}}
* {{Item|Torches|inline=1}}
There is also a {{Item|Spruce Display|inline=1}} which holds:
* a pair of {{Item|Leather Dashers|inline=1}}
{{Tip|tip|[[Leather Dashers]] are an [[Trinkets#Ability Trinkets|Ability Trinket]] which allows the player to [[Dashing|Dash]] at the expense of [[Stamina]].
}}}} 
{{ItemList|compact|
|
==== Spawn Points and Beds ====
The Elder's {{item|Bed|inline=1}} can be used to set a spawn point inside the house. 
This is the place the player will return to when they die.
{{tip|note|You will be able to craft your own beds later.Beds can be used to skip between day and night if all players are in bed. we will go more into the day and night cycle shortly}}}}
{{ItemList|compact|
|
==== The Elder's Storagebox ====
There is a {{Item|Storagebox|inline=1}} in the elders house that the player can take items from which contains:
* {{Item|Village Map|inline=1}}
* {{Item|Dungeon Map|inline=1}}
* {{Item|Bread|inline=1}}
* {{Item|Health Potion|inline=1}}
* {{Item|Settlement Flag|inline=1}}
{{Tip|note|A [[Settlement Flag]] is used to start a [[Settlements|settlement]].
The flag can be placed on any [[terrain]] [[Tiles|tile]] outside or inside the house. Go ahead and do this now as we will need it placed later to take a quest from the elder, We will cover [[Guide:Getting_Started/Settlements|Settlements]] in more detail later in the guide}}}}
{{ItemList|compact|
|
==== Cave Ladder ====
{{Tip|warning|The elders house also has a {{Item|Cave Ladder|inline=1}} to go down into the [[Caves]] but we arent quite ready for that yet.}}
}}

{{ItemList|compact|
|
=== Outside the Elders House ===
Outside the house is a {{Item|Roasting Station|inline=1}} on top of a {{Item|Campfire|inline=1}} which you can use to cook raw meat from:
* {{Item|Cow|inline=1}}
* {{Item|Sheep|inline=1}}
and other [[Animals]]

{{Tip|note|It's best not to kill the animals near your spawn as you can use them later for [[Animals#Taming|Taming]], [[Animals#Breeding|Breeding]] and [[Animals#Harvesting|Harvesting]].}}}}

=Exploring the World=
===Day And Night Cycle===
{{tip|note|The world has a day and night cycle. in the forest nothing hostile will spawn during the day but [[Zombie]]s come out at night so be sure to take shelter or be prepared to fight }}

== Obtaining Mining Gear ==
{{ItemList|compact|Head outside of the [[elder]]s house and chop down some [[Trees]].
|
In the forest it will be either:
* {{item|Oak Tree|inline=1|size=32px}}
* {{item|Spruce Tree|inline=1|size=32px}}
{{tip|tip|You can chop trees down with the {{item|Wood Axe|inline=1}} that came in your starting inventory and collect the [[Logs]] and [[Saplings]] that drop.

You should cut down more than you need so that you can use the extra logs to craft more torches and replant the saplings near the elders house to grow over time.
}}}}
{{ItemList|compact|
|
Before We head down to the [[Caves]] we need at least:
* {{item|Oak Log|inline=1|size=32px|2}} to make a {{item|Wood Pickaxe|inline=1}}
* 10 logs and 10 saplings to make {{item|Torch|inline=1|size=32px|40}}
{{Tip|warning|Torches are essential in caves — darkness hides enemies and hazards.}}}}

{{ItemList|compact|Once you have all of these head over to the {{item|Workstation|inline=1}} inside the [[Elder]]s house and craft:
|
* {{item|Wood Pickaxe|inline=1}}
* {{item|Torch|inline=1|40}}
}}
= Food =
=== Food Spoilage ===

{{tip|tip|
Food in your backpack and regular {{Item|Storagebox|inline=1}} will spoil over time and different foods have their own spoil times. once this time reaches 0 it becomes {{item|Spoiled Food|inline=1}} which has its own uses which we will get into later
}}
=== Food Buffs ===
{{ItemList|compact|
|
{{tip|tip| Food items are very important in Necesse and not just to stave off [[Guide:Getting_Started/User_Interface#Hunger|hunger]]: not only do different food items restore your hunger by differing amounts they also all give the player buffs dependant on the food item consumed. 
Food items can be separated into Raw, Fine and Gourmet with the buffs received getting better the higher the quality of food is, but we will go into that later }}{{tip|warning|you can only have one food buff at a time and consuming another will remove the previous buff instantly}}
}}

{{ItemList|compact|
|
I wont go into a great deal about the different food or food buffs right now but I will cover the first few you are likely to encounter:
==[[Simple Food]]==
===Fruits ===
These are classed as simple raw foods that have a positive buff when eaten:
* {{Item|Apple|inline=1|+2% Movement Speed}}
* {{Item|Blueberry|inline=1|+2% Crit Chance}}
=== Raw Meat ===
These are raw meats. you shouldn't eat these without [[Guide:Getting_Started#Outside the Elders House|cooking them]] otherwise you will take 10 damage
* {{Item|Beef|inline=1|-10 Health}}(becomes {{Item|Steak|inline=1}} when cooked)
* {{Item|Raw Mutton|inline=1|-10 Health}}(becomes {{Item|Roasted Mutton|inline=1}} when cooked)
== [[Fine Food]]s ==
* {{Item|Steak|inline=1|+2% Damage}}
* {{Item|Roasted Mutton|inline=1|+2% Crit Chance}}
* {{Item|Bread|inline=1|+20 Max Health}}
}}

= Final Preparations =

{{ItemList|compact|If you haven't already make sure you grab:
|
* {{item|Bread|inline=1}}
* {{item|Health Potion|inline=1}}

from the chest or:
* find some {{item|Blueberry|inline=1}} from {{item|Blueberry Bush|inline=1|size=32px}} in the surrounding forest.
{{Tip|tip|If you come across any {{item|Blueberry Bush|inline=1|size=32px}} you should break these and place them near the elders house as an early source of food.

Carrying food and healing items greatly increases your survival chances underground.}}}}
 
Your inventory should look a little like this:

{{NecesseBuild
|cosmetic_feet=Shoes
|ability_trinket=Leather Dashers

|hotbar1=Wood Pickaxe
|hotbar2=Wood Axe
|hotbar3=Wood Sword

|hotbar4=Torch
|hotbar4_qty=40

|hotbar5=Bread
|hotbar5_qty=9

|hotbar6=Blueberry
|hotbar6_qty=12

|hotbar7=Health Potion
|hotbar7_qty=5
}}

=== Down We Go ===

{{Tip|map|If you feel unsure, you can always gather more supplies before entering the caves. 
Head over to the cave ladder for
[[Guide:Getting_Started/Your_First_Cave|Your First Cave]]
when you feel comfortable you have everything you need.}}

[[Category:Guides]]

Guide:Getting Started

2025-12-31T02:37:02Z

Jamesp1989: /* The Elders House */

= Getting Started Guide =

{{tip|tip|Welcome to the wonderful world of '''Necesse'''. This game may seem slightly overwhelming but let me reassure you, the basics of this game can be learned quite easily.}}
 

== Joining A World For The First Time ==

When starting a new world or joining a multiplayer world for the first time you will need to create a new character we call [[The Player]].

{{Tip|note|Your character can be reused across multiple worlds, so don’t worry too much about early choices.}}
 
[[File:Create player.jpg|300px]] 

== Your Starting Location ==

Once you load into the world I suggest you head into the house you spawn by and take a look at the
[[Guide:Getting_Started/User Interface|User Interface]] and [[Controls]] pages to familiarise yourself with them.

{{Tip|tip|Knowing your controls early will make combat and exploration much easier later on.}}
 

[[File:The Elders House.png|500px]] 
''The player's default spawn point near the Elder's House.'' 

== Player Inventory ==
{{ItemList|compact|The player's starting inventory includes:
|
* {{Item|Wood Axe|inline=1}}
* {{Item|Wood Sword|inline=1}}
* {{Item|Crafting Guide|inline=1}}{{Tip|note|These starting tools are enough to begin gathering resources and crafting basic equipment.}}}}

[[File:The Players Starting Inventory.png|500px]] 
''Starting inventory.'' 

{{ItemList|compact|
|
== The Elders House ==
In new worlds, the player spawns in a [[Forest Biome]] next to the house of the [[Elder]], if the corresponding option was selected when creating the world.
The [[Elder]] is your game guide and [[quests]] giver. He will provide useful and sometimes unique rewards for completing quests, so don't ignore him.

{{Tip|tip|Completing the Elder’s quests is one of the easiest ways to follow intended [[Guide:Getting_Started/Progression|Progression]]}}
}}

{{ItemList|compact|
|
=== Inside the Elders House ===
In the Elder's house, the player will find a {{Item|Workstation|inline=1}} where they can craft their first equipment needed for the further exploration, such as:
* {{Item|Wood Pickaxe|inline=1}}
* {{Item|Wood Shovel|inline=1}}
* {{Item|Wood Boat|inline=1}}
* {{Item|Torches|inline=1}}
There is also a {{Item|Spruce Display|inline=1}} which holds:
* a pair of {{Item|Leather Dashers|inline=1}}
{{Tip|tip|[[Leather Dashers]] are an [[Trinkets#Ability Trinkets|Ability Trinket]] which allows the player to [[Dashing|Dash]] at the expense of [[Stamina]].
}}}} 
{{ItemList|compact|
|
==== Spawn Points and Beds ====
The Elder's {{item|Bed|inline=1}} can be used to set a spawn point inside the house. 
This is the place the player will return to when they die.
{{tip|note|You will be able to craft your own beds later.Beds can be used to skip between day and night if all players are in bed. we will go more into the day and night cycle shortly}}}}
{{ItemList|compact|
|
==== The Elder's Storagebox ====
There is a {{Item|Storagebox|inline=1}} in the elders house that the player can take items from which contains:
* {{Item|Village Map|inline=1}}
* {{Item|Dungeon Map|inline=1}}
* {{Item|Bread|inline=1}}
* {{Item|Health Potion|inline=1}}
* {{Item|Settlement Flag|inline=1}}
{{Tip|note|A [[Settlement Flag]] is used to start a [[Settlements|settlement]].
The flag can be placed on any [[terrain]] [[Tiles|tile]] outside or inside the house. Go ahead and do this now as we will need it placed later to take a quest from the elder, We will cover [[Guide:Getting_Started/Settlements|Settlements]] in more detail later in the guide}}}}
{{ItemList|compact|
|
==== Cave Ladder ====
{{Tip|warning|The elders house also has a {{Item|Cave Ladder|inline=1}} to go down into the [[Caves]] but we arent quite ready for that yet.}}
}}

{{ItemList|compact|
|
=== Outside the Elders House ===
Outside the house is a {{Item|Roasting Station|inline=1}} on top of a {{Item|Campfire|inline=1}} which you can use to cook raw meat from:
* {{Item|Cow|inline=1}}
* {{Item|Sheep|inline=1}}
and other [[Animals]]

{{Tip|note|It's best not to kill the animals near your spawn as you can use them later for [[Animals#Taming|Taming]], [[Animals#Breeding|Breeding]] and [[Animals#Harvesting|Harvesting]].}}}}

=Exploring the World=
===Day And Night Cycle===
{{tip|note|The world has a day and night cycle. in the forest nothing hostile will spawn during the day but [[Zombie]]s come out at night so be sure to take shelter or be prepared to fight }}

== Obtaining Mining Gear ==
{{ItemList|compact|Head outside of the [[elder]]s house and chop down some [[Trees]].
|
In the forest it will be either:
* {{item|Oak Tree|inline=1|size=32px}}
* {{item|Spruce Tree|inline=1|size=32px}}
{{tip|tip|You can chop trees down with the {{item|Wood Axe|inline=1}} that came in your starting inventory and collect the [[Logs]] and [[Saplings]] that drop.

You should cut down more than you need so that you can use the extra logs to craft more torches and replant the saplings near the elders house to grow over time.
}}}}
{{ItemList|compact|
|
Before We head down to the [[Caves]] we need at least:
* {{item|Oak Log|inline=1|size=32px|2}} to make a {{item|Wood Pickaxe|inline=1}}
* 10 logs and 10 saplings to make {{item|Torch|inline=1|size=32px|40}}
{{Tip|warning|Torches are essential in caves — darkness hides enemies and hazards.}}}}

{{ItemList|compact|Once you have all of these head over to the {{item|Workstation|inline=1}} inside the [[Elder]]s house and craft:
|
* {{item|Wood Pickaxe|inline=1}}
* {{item|Torch|inline=1|40}}
}}
= Food =
=== Food Spoilage ===

{{tip|tip|
Food in your backpack and regular {{Item|Storagebox|inline=1}} will spoil over time and different foods have their own spoil times. once this time reaches 0 it becomes {{item|Spoiled Food|inline=1}} which has its own uses which we will get into later
}}
=== Food Buffs ===
{{ItemList|compact|
|
{{tip|tip| Food items are very important in Necesse and not just to stave off [[Guide:Getting_Started/User_Interface#Hunger|hunger]]: not only do different food items restore your hunger by differing amounts they also all give the player buffs dependant on the food item consumed. 
Food items can be separated into Raw, Fine and Gourmet with the buffs received getting better the higher the quality of food is, but we will go into that later }}{{tip|warning|you can only have one food buff at a time and consuming another will remove the previous buff instantly}}

I wont go into a great deal about the different food or food buffs right now but I will cover the first few you are likely to encounter:
{{ItemList|compact|
|
==[[Simple Food]]==
===Fruits ===
These are classed as simple raw foods that have a positive buff when eaten:
* {{Item|Apple|inline=1|+2% Movement Speed}}
* {{Item|Blueberry|inline=1|+2% Crit Chance}}
=== Raw Meat ===
These are raw meats. you shouldn't eat these without [[Guide:Getting_Started#Outside the Elders House|cooking them]] otherwise you will take 10 damage
* {{Item|Beef|inline=1|-10 Health}}(becomes {{Item|Steak|inline=1}} when cooked)
* {{Item|Raw Mutton|inline=1|-10 Health}}(becomes {{Item|Roasted Mutton|inline=1}} when cooked)
== [[Fine Food]]s ==
* {{Item|Steak|inline=1|+2% Damage}}
* {{Item|Roasted Mutton|inline=1|+2% Crit Chance}}
* {{Item|Bread|inline=1|+20 Max Health}}
}}}}

= Final Preparations =

{{ItemList|compact|If you haven't already make sure you grab:
|
* {{item|Bread|inline=1}}
* {{item|Health Potion|inline=1}}

from the chest or:
* find some {{item|Blueberry|inline=1}} from {{item|Blueberry Bush|inline=1|size=32px}} in the surrounding forest.
{{Tip|tip|If you come across any {{item|Blueberry Bush|inline=1|size=32px}} you should break these and place them near the elders house as an early source of food.

Carrying food and healing items greatly increases your survival chances underground.}}}}
 
Your inventory should look a little like this:

{{NecesseBuild
|cosmetic_feet=Shoes
|ability_trinket=Leather Dashers

|hotbar1=Wood Pickaxe
|hotbar2=Wood Axe
|hotbar3=Wood Sword

|hotbar4=Torch
|hotbar4_qty=40

|hotbar5=Bread
|hotbar5_qty=9

|hotbar6=Blueberry
|hotbar6_qty=12

|hotbar7=Health Potion
|hotbar7_qty=5
}}

=== Down We Go ===

{{Tip|map|If you feel unsure, you can always gather more supplies before entering the caves. 
Head over to the cave ladder for
[[Guide:Getting_Started/Your_First_Cave|Your First Cave]]
when you feel comfortable you have everything you need.}}

[[Category:Guides]]