Skip to content

Fivemon Documentation Structure

This page explains how the Fivemon documentation is structured so you can navigate it efficiently and understand where to find the information you need depending on the topic.

At the top of the documentation site, next to the Fivemon Wiki title, you’ll find a version selector. This allows you to switch between different published versions of the documentation (e.g., 0.2, latest, etc.), which is useful when working with older builds of the project.

To the right of the navigation bar:

  • There is a button to toggle dark mode 🌓, allowing users to choose between light or dark themes depending on their preference.
  • A search input 🔍 is also available, which performs a full-text search across all documentation pages, regardless of the section you're in.

📌 Main Sections: Home, Guides, Core, and Monsters

The documentation is organized into three main sections:

🏠 Home

Includes general information about the project. It’s ideal for new users looking to understand what this project is about.

📙 Guides

Contains walkthroughs and step-by-step tutorials. These guides help you understand and implement features, for example, learning .uri, or creating custom spawns.

🧱 Core

Focused on the main framework and general gameplay systems. This includes topics like the custom language .uri, items, zones, achievements, and general configuration features available in the framework.

🐾 Monsters

Covers everything related to monster creatures in Fivemon: from how teams and interactions work to battle systems, skills, and the Monsterdex.

Each of these major sections may contain four internal categories: Resources, Utilities, and Extensions. They are presented using tables and lists.

📦 Resources

Resources are structured data sets that provide the base content for each system.

Examples:

  • In Core: item.
  • In Monsters: monster items, monsters data, moves.

These often correspond to .json files.

🛠 Utilities

The Utilities section documents tools and definitions for configuration and runtime control.

You’ll find:

  • A full list of available commands and their usage.
  • Argument types supported by the command system.
  • Descriptions of what can be configured.
  • Detailed explanation of content files like items.json, recipes.json, and where and how modify custom content.
  • Controls for in-game use.

This section is essential for developers and server owners who want fine-grained control over the game behavior.

🧩 Extensions

Extensions expand .uri, Fivemon’s custom logic language. These allow you to build complex behaviors and missions without having to write additional Lua code.

  • Actions – Behaviors an NPC can execute, like triggering dialogue or moving to a location.
  • Conditions – Logic used to check whether a quest can start/keep.
  • Constructors – Used in .uri to spawn or create entities like NPCs, objects, or quests.
  • Events – Customizable triggers used in missions goals or achievements.
  • ItemUse Templates – Define functionality directly in items.json (e.g., using the drink template to reduce thirst).
  • Requirements – Validate if a player meets a condition for a quest (e.g., owns a specific item).
  • Rewards – Define what is granted after completing a quest, such as item or money.

Fivemon’s documentation is designed to be modular, readable, and scalable — whether you’re just getting started or extending the system with custom logic. Use the left menu or the search bar to dive in based on your current needs.