-
Notifications
You must be signed in to change notification settings - Fork 8
Environment Variables
Environment variables can be used to affect Everest, sometimes overlapping with in-game Settings or Command Line Arguments.
Variables can also be added to an everest-env.txt file next to everest-launch.txt, and will be loaded automatically by Everest.
Note that some of these variables are not maintained/tested, and may not work as intended. Please open an issue 🔗 and update this page if a broken variable is not already documented as such.
Enables headless mode for Everest.
Values: 1 or 0 (default)
Everest will avoid using RenderTargets.
Values: 1 or 0 (default)
Suppresses the automatic opening of the Error Log on crash.
Values: 1 or 0 (default)
Initializes the Local Lua Debugger 🔗 when loading a LuaModule.
Values: 1 or 0 (default)
Sets the directory where the Saves folder is located.
- Applies to vanilla and Everest saves.
Value: path
Enables or disables requesting window focus after the game window shows up. When empty the focus request will only be triggered if the everest boot splash was enabled, but if its assigned to 1 or 0 the focus request will be performed/skipped regardless of the splash configuration, respectively.
*Values: 1, 0 or empty (default)
Other libraries used by Everest and Celeste have their own environment variables that can be set to configure their behaviour. Any notable examples will be included here, but for a full reference please see the documentation for those libraries.
Home
Contributing
FAQ
Useful Links
Your First Custom Map
Your First Texture Pack
Mod Setup
Custom Maps
Texture Packs
Uploading 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
Skinmods
Decal Registry
Chapter Complete Screen
Custom Portraits
Adding Custom Audio
Advanced Custom Audio
Getting started in code modding from 0
Code Mod Setup
Making Code Mods
Settings, SaveData and Session
Everest Events
Understanding Input
Logging
Cross-Mod Functionality
Recommended Practices
Core Migration Guide
Lönn Integration🔗
Custom Events
Adding Sprites
Adding Preexisting Audio