-
Notifications
You must be signed in to change notification settings - Fork 7
Home
Welcome to the Everest 🔗 Wiki!
Come say hi on the Celeste Discord 🔗, and tell us what you're working on!
Make sure to check out the sidebar on the right for the full list of community-written guides, tutorials, and reference pages.
Step-by-step walkthroughs for new modders that guide you through creating your first mod:
General, unopinionated checklists that consolidate the information you need:
- Mod Setup (Required for all types of mods)
- Custom Maps
- Texture Packs
- Custom Audio
- Lua Cutscenes 🔗 (Simple cutscenes written in Lua)
-
Code Mods (Written in C#)
- Core Migration Guide (How to migrate an older code mod so it works on .NET Core Everest)
- Lönn Plugins 🔗
Technical descriptions and informational lists:
- The
everest.yaml
File - Generated Dialog Keys
- Vanilla Audio IDs
- Custom Maps
- Code Mods
While some of the vanilla map and entity configuration is available in the game files, some is either hardcoded or in a different format from what Everest supports. The following pages contain data exported from vanilla into the format supported by Everest:
We are always looking for people to help contribute to this wiki!
Feel free to add Tutorials, reference guides, or anything else you might think is needed. After adding a page, please add it to the Sidebar under the relevant category, or add a new category if necessary.
Where possible, we are trying to update old pages and create new pages following the system described here 🔗.
If you want to modify this wiki using git, follow the instructions here 🔗, bundle 🔗 your changes and ping an Everest Team member to get them added.
If you plan on moving or renaming files, please use git filter-repo --path-rename
🔗 to change their paths in history. GitHub wikis cannot handle renamed files. For prominent pages that may be linked to often, keep the original page with a link to the renamed one.
Note that all relative links to other wiki pages should be treated as if all files are in the same folder.
If you are working on a page, add it to the In Progress section of this article.
For any questions, join the celeste Discord 🔗 and ask under #modding_help
- Ouis
- Celeste Reference
- Monocle Reference
This is a compilation of as-yet undocumented Everest features.
It's purpose is to serve as a place to check if a feature exists, and as a to-do list for future documentation.
Links to relevant source-code, commits, or PRs should be included.
Home
Contributing
FAQ
Useful Links
Your First Custom Map
Your First Texture Pack
Mod Setup
Custom Maps
Texture Packs
Publishing Mods
Generated Dialog Keys
Reference Code Mod🔗
Vanilla Audio IDs
Character Portraits
Mod Structure
Debug Mode
Command Line Arguments
Environment Variables
Install Issues
Common Crashes
Latency Guide
everest.yaml Setup
Mapping FAQ
Map Metadata
Vanilla Metadata Reference
Adding Custom Dialogue
Overworld Customisation
Entity & Trigger Documentation
Custom Entity List🔗
Camera
Ahorn Scripts
Custom Tilesets
Tileset Format Reference
Stylegrounds
Reskinning Entities
Decal Registry
Chapter Complete Screen
Custom Portraits
Adding Custom Audio
Advanced Custom Audio
Code Mod Setup
Making Code Mods
Mod Settings
Everest Events
Understanding Input
Logging
Cross-Mod Functionality
Recommended Practices
Core Migration Guide
Lönn Integration🔗
Custom Events
Adding Sprites
Adding Preexisting Audio