Difference between revisions of "Quick Start & Modding Basics"

From Nebuchadnezzar Modding Wiki
Jump to navigation Jump to search
Line 23: Line 23:
 
*'''Definition files''' - They contains information about new entities or changes in the current entities.
 
*'''Definition files''' - They contains information about new entities or changes in the current entities.
 
*'''Data files''' - Data which are referenced by the definition files. Typically sprite images.
 
*'''Data files''' - Data which are referenced by the definition files. Typically sprite images.
 
 
 
  
 
== Definition files ==
 
== Definition files ==
Line 31: Line 28:
 
*It means you can use most of Lua language features. Such like variable, aritmetic operations or functions.
 
*It means you can use most of Lua language features. Such like variable, aritmetic operations or functions.
  
=== Atom name ===
+
== Atoms ==
*Atom name is the most imporatant property of each atom.
 
*It has form <code>mod_name::raw_name</code>
 
** <code>mod_name</code> part is important because it allows us to unequivocally reference atoms from other mods
 
** <code>raw_name</code> is then name identifying atom within the mod
 
 
 
== Definition files and atoms structure ==
 
 
The basic unit of the game is '''Atom'''.
 
The basic unit of the game is '''Atom'''.
 
*Each entity in the game is defined as a atom. For example single atom is building, walker, employee, mission, city, goods etc.
 
*Each entity in the game is defined as a atom. For example single atom is building, walker, employee, mission, city, goods etc.

Revision as of 23:16, 3 February 2021

Types of mods

Nebuchadnezzar supports three type of mods:

All mods types have the same data structure and provides the same functionality. They only differ in the way how to obtain them and where are stored.

Local mods

  • These mods can be downloaded from any sources.
  • These mods are supported on all distributions platforms builds (Steam, Gog and any future platforms).

Steam Workshop mods

  • These mods can be downloaded through the Steam Workshop system.
  • For Steam builds only.

Developer mods

  • Special variant of local mods.
  • Used to develop and upload your mods.

What is moddable?

Everything except the tutorial, guide, UI and fonts. That means, you can create or edit goods, production chains, buildings, monuments, maps, missions or even ther whole campaigns and more.

Mod files structure

Each mod has two types of files. These are:

  • Definition files - They contains information about new entities or changes in the current entities.
  • Data files - Data which are referenced by the definition files. Typically sprite images.

Definition files

Definition files, in short def files, are written in Lua language.

  • It means you can use most of Lua language features. Such like variable, aritmetic operations or functions.

Atoms

The basic unit of the game is Atom.

  • Each entity in the game is defined as a atom. For example single atom is building, walker, employee, mission, city, goods etc.
  • Each atom has properties from which some are obligatory and some are optional. Depending on a type of the atom.

Atom name

  • Atom name is the most imporatant property of each atom.
  • It has form mod_name::raw_name
    • mod_name part is important because it allows us to unequivocally reference atoms from other mods
    • raw_name is then name identifying atom within the mod