Official Open-Source Sample Projects

The ModSamples directory under the game installation directory contains official MOD project templates, reference projects, and script resources. When a new project is created in game, the game copies a new project directory from the corresponding template directory.

Create a Project In Game

In-Game Option	Template Directory	Description
Simple MOD Project	ModProject	Suitable for creating story content, config tables, and resources from a basic project structure.
Professional MOD Project (requires Unity 2020.3.48f1)	ModProjectPro	Suitable for professional MOD projects that need a Unity project and resource packaging workflow.
[Sample Project] Story Campaign Tutorial Sample	Example_MapStory	Includes examples for maps, map roles, items, stories, and triggers, useful for learning story campaign project structure.
[Sample Project] Game Map Open-Source Sample	Example_GameMapProject	Provides a game map sample for referencing map projects, map resources, and map configuration.

Reference Directories

Example_CSharpLuaReference

Lua type reference files. Use them with a Lua editor to view hints for public game types, methods, and members.

Example_ExcelReference

Config table references and replaceable resource examples. Use them to look up fields, IDs, and resource override directory structures.

Example_GUIResource

GUI project resource examples. Use them to learn UI package structure, UI resources, and FairyGUI project organization.

LuaScripts

Lua script examples, including shared logic, GUI, mobile UI, and exploration-related scripts.

ModResources

Model, skeleton, controller, and UnityPackage resource examples for creating role, weapon, and action resources.

ScriptInterfaces

Script interface references, including interface types callable from MOD scripts and examples of game command base classes.

SkillData

Skill script text examples. Use them together with the battle skill command documentation to learn skill script syntax.