Evennia 文件

這是 Evennia 的使用手冊。Evennia 是開源的 Python MU* 建構系統。請使用左側的搜尋列來查找或探索你感興趣的文章。本手冊最後更新於 2026 年 4 月 11 日，詳見 Evennia Changelog。目前最新正式發布的 Evennia 版本為 6.0.0。

• 簡介 - Evennia 到底是什麼？

• Evennia 圖解 - 用圖像快速了解 Evennia

• 如何貢獻與取得協助 - 當你卡住，或想一起參與時

安裝與設定

• 安裝 - 開始上手

• 執行遊戲 - 如何啟動、停止與重新載入 Evennia

• 更新伺服器 - 如何更新 Evennia

• 設定 - 依照你的需求調整 Evennia

• 上線 - 讓你的遊戲對外開放

教學與 Howto

• 新手教學 - 學習基礎並做出一個小型遊戲（進行中）

• 教學與 Howto - 各種教學與操作文章，幫助你學習 Evennia

• 使用 Evennia 開發 - 撰寫程式與開發的資源與提示

Evennia 函式庫

• 核心元件 - Evennia 的核心積木

• 核心概念 - 較大尺度的概念與功能

• API 參考（英文） - 完整的自動生成 API 參考目前仍維持英文

Contrib 與其他資訊

• Contribs - 可用於你遊戲的特定程式碼與範例

• 文件：如何貢獻 - 如果你想協助這份手冊

• 授權 - Evennia 授權常見問答

• 連結 - 其他值得延伸閱讀的資源

---

All Sections

點這裡展開完整文件索引。

• Evennia 簡介
  • Evennia 是什麼？
    • Bare-bones？
    • Framework？
    • Server？
    • Python？
  • 我可以先在哪裡試試看？
  • 想使用 Evennia，我需要會什麼？
    • 我不會寫程式，或者不想寫，我只想把遊戲跑起來！
    • 我懂一點 Python，或者願意學
    • 我很熟 Python，而且願意好好用上它！
  • 接下來往哪裡走？
• Evennia 圖解
  • Evennia 的兩大組件
    • 初始化遊戲目錄
  • 資料庫
    • 從資料庫到 Python
    • Attributes
  • 控制遊戲行為
    • Commands
    • Command Sets
    • 合併 Command Sets
  • 現在就去探索吧！
• Start Stop Reload
  • Starting Evennia
  • Reloading
  • Stopping
  • Foreground mode
  • Resetting
  • Rebooting
  • Status and info
  • Killing (Linux/Mac only)
  • Django options
  • Advanced handling of Evennia processes
    • Syntax errors during live development
• Updating Evennia
  • If you installed with pip
  • If you installed with git
  • If you installed with docker
  • Resetting your database
    • SQLite3 (default)
    • PostgreSQL
    • MySQL/MariaDB
    • What are database migrations?
• Server Setup and Life
  • Installation and running
    • Installation
    • Installing with GIT
    • Installing with Docker
    • Installation Troubleshooting
    • Installing on Android
    • Upgrading an existing installation
    • Non-interactive setup
    • Start Stop Reload
    • Updating Evennia
  • Configuration
    • Changing Game Settings
    • Evennia Default settings file
    • Choosing a database
    • Connect Evennia channels to Discord
    • Connect Evennia channels to Grapevine
    • Connect Evennia channels to IRC
    • Connect Evennia channels to RSS
    • Connect Evennia to Twitter
  • Going Online
    • Evennia Game Index
    • Online Setup
    • Client Support Grid
    • Security Hints and Practices
    • Configuring HAProxy
    • Configuring NGINX for Evennia with SSL
    • Configuring an Apache Proxy
• Tutorials and How-To’s
  • Beginner Tutorial
    • Beginner Tutorial
    • Part 1: What We Have
    • Part 2: What We Want
    • Part 3: How We Get There (Example Game)
    • Part 4: Using What We Created
    • Part 5: Showing the World
  • How-To’s
    • Adding a Command Prompt
    • Adding Command Cooldowns
    • Commands that take time to finish
    • Return custom errors on missing Exits
    • Give objects weight
    • NPCs that listen to what is said
    • NPCs reacting to your presence
    • NPC merchants
    • Building a giant mech
    • Building a train that moves
  • Systems
    • Making a Persistent object Handler
    • Changing game calendar and time speed
    • Adding Weather messages to a Room
    • Adding room coordinates to your game
    • Show a dynamic map of rooms
  • Website Tutorials
    • Changing the Game Website
    • Add a wiki on your website
    • Web Character Generation
    • Web Character View Tutorial
    • Web Help System Tutorial
    • Extending the REST API
    • Automatically Tweet game stats
  • Deep Dives
    • Parsing command arguments, theory and best practices
    • Understanding Color Tags
    • Evennia for roleplaying sessions
    • Evennia for Diku Users
    • Evennia for MUSH Users
    • Using the Arxcode game dir
  • Old Tutorials
    • Implementing a game rule system
    • Turn based Combat System
    • Tutorial for basic MUSH like game
• Core Components
  • Base components
    • Portal And Server
    • Sessions
    • Typeclasses
    • Accounts
    • Objects
    • Characters
    • Rooms
    • Exits
    • Scripts
    • Channels
    • Msg
    • Attributes
    • Nicks
    • Tags
    • Spawner and Prototypes
    • Help System
    • Permissions
    • Locks
  • Commands
    • Commands
    • Command Sets
    • Default Commands
    • Batch Processors
    • Inputfuncs
  • Utils and tools
    • Coding Utils
    • EvEditor
    • EvForm
    • EvMenu
    • EvMore
    • EvTable
    • FuncParser inline text parsing
    • MonitorHandler
    • OnDemandHandler
    • TickerHandler
    • Signals
  • Web components
    • Game website
    • Web Client
    • The Web Admin
    • Webserver
    • Evennia REST API
    • Bootstrap frontend framework
• Core Concepts
  • General concepts
    • The Message path
    • Out-of-Band messaging
    • Async Process
  • Text processing
    • In-text tags parsed by Evennia
    • Messages varying per receiver
    • Internationalization
    • Text Encodings
  • Access
    • Character connection styles
    • Guest Logins
    • Banning
  • Extending the Server
    • Evennia Server Lifecycle
    • Protocols
    • New Models
    • Zones
• Coding and development help
  • Evennia Code Style
    • Main code style specification
    • Code Docstrings
    • Default Command Docstrings
    • Tools for auto-linting
  • Default Command Syntax
  • Coding using Version Control
    • Setting up Git
    • Common Git commands
    • Putting your game dir under version control
    • Contributing to Evennia
    • Troubleshooting
  • Debugging
    • Debugging Evennia
    • A simple example using pdb
    • Cheat-sheet of pdb/pudb commands
    • Debugging with debugpy
  • Unit Testing
    • Running the Evennia test suite
    • Running custom game-dir unit tests
    • Writing new unit tests
  • Profiling
    • Simple timer tests
    • Using cProfile
    • The Dummyrunner
  • Continuous Integration (CI)
    • Continuous-Integration guides
  • Setting up PyCharm with Evennia
    • From an existing project
    • From a new project
    • Debug Evennia from inside PyCharm
  • Evennia Changelog
    • Changelog
    • Overview-Changelogs
    • Older
• Contribs
  • Index
  • base_systems
    • AWSstorage system
    • Building menu
    • Additional Color markups
    • Components
    • Custom gameime
    • Email-based login system
    • Godot Websocket
    • Evennia in-game Python system
    • In-Game Reporting System
    • Menu-based login system
    • Legacy Comms-commands
    • Unix-like Command style
    • awsstorage
    • building_menu
    • color_markups
    • components
    • custom_gametime
    • email_login
    • godotwebsocket
    • ingame_python
    • ingame_reports
    • menu_login
    • mux_comms_cmds
    • unixcommand
  • full_systems
    • EvscapeRoom
    • evscaperoom
  • game_systems
    • Achievements
    • Barter system
    • Clothing
    • Containers
    • Cooldowns
    • Crafting system
    • Gendersub
    • In-Game Mail system
    • Evennia Multidescer
    • Puzzles System
    • Item Storage
    • Turn based battle system framework
    • achievements
    • barter
    • clothing
    • containers
  • Installation
    • cooldowns
    • crafting
    • gendersub
    • mail
    • multidescer
    • puzzles
    • storage
    • turnbattle
  • grid
    • Extended Room
    • Basic Map
    • Map Builder
    • SimpleDoor
    • Slow Exit
    • Wilderness system
    • XYZgrid
    • extended_room
    • ingame_map_display
    • mapbuilder
    • simpledoor
    • slow_exit
    • wilderness
    • xyzgrid
  • rpg
    • Buffs
    • Character Creator
    • Dice roller
    • Health Bar
    • Large Language Model (“Chat-bot AI”) integration
    • Roleplaying base system for Evennia
    • Traits
    • as TraitProperty
    • buffs
    • character_creator
    • dice
    • health_bar
    • llm
    • rpsystem
    • traits
  • tutorials
    • Batch processor examples
    • Script example
    • EvAdventure
    • TutorialMirror
    • Red Button example
    • Talkative NPC example
    • Evennia Tutorial World
    • batchprocessor
    • bodyfunctions
    • evadventure
    • mirror
    • red_button
    • talking_npc
    • tutorial_world
  • utils
    • Input/Output Auditing
    • DebugPy VSCode debugger integration
    • Easy fillable form
    • In-game Git Integration
    • Random Name Generator
    • Pseudo-random generator and registry
    • Easy menu selection tree
    • auditing
    • debugpy
    • fieldfill
    • git_integration
    • name_generator
    • random_string_generator
    • tree_select
• 如何貢獻並取得協助
  • 取得協助
  • 如何幫忙
    • 協助文件
    • 協助程式碼
    • 以捐款支持
• 貢獻 Evennia 文件
  • 原始檔結構
  • 自動生成的文件頁
  • 編輯語法
    • Italic/Bold（斜體/粗體）
    • Headings（標題）
    • Lists（列表）
    • Blockquotes（引用區塊）
    • Links（連結）
    • 將 URLs/References 集中寫在一處
    • Tables（表格）
    • Verbatim text（原樣文字）
    • Code blocks（程式碼區塊）
    • MyST directives
  • 為 autodocs 撰寫程式碼 docstrings
  • 在本機建置文件
    • 只建置主要文件
    • 建置主要文件與 API docs
    • 建置 multiversion docs
• 授權 Q&A
• 連結
  • Evennia 官方資源
  • Evennia 社群
  • 第三方 Evennia 資源
    • 其他
  • 一般 MU* 資源
    • MU* 工具
    • 參考資料
    • 有趣的社群
  • 一般遊戲開發資源
    • 遊戲開發工具
    • Frameworks
    • 學習 Python
    • 一般 RPG
    • 書籍與閱讀