uMod Guides

The guides below are for uMod, not Oxide. To read about some of the major changes with uMod, see the release notes.

Universal

Foreword

  1. Release notes
  2. Upgrade guide
  3. Contribution guide
  4. Reporting issues

Getting Started

  1. Installation (pre-release)
  2. Installation
  3. Agent
  4. Plugins
  5. Server
  6. Configuration
  7. Directory structure
  8. Commands
  9. Permissions
  10. Localization

Architecture

  1. Unity versions
  2. Target frameworks
  3. Server lifecycle
  4. Plugin lifecycle
  5. Service container
  6. Contracts
  7. Applications

The Basics

  1. Plugins
  2. Hooks
  3. Commands
  4. Validation
  5. Configuration
  6. Localization
  7. Schematics
  8. Filesystem
  9. Preprocessors
  10. Gates
  11. Players
  12. Integration
  13. Timers
  14. Logging
  15. Text Styling

Server Management

  1. Performance
  2. Popular tools
  3. Security

Development

  1. Setting up environment
  2. Approval guide
  3. Plugin collaboration
  4. Contributing hooks

Advanced

  1. Hook events
  2. Web requests
  3. Pooling
  4. Duck typing
  5. Hook decorators
  6. Promises
  7. Database
  8. Modeling

Reviewers

  1. Guidelines
  2. Workflow

Oxide

  1. Disabling plugin sandboxing

Rust

  1. Server sections
  2. Basic concepts of GUI

Valheim

  1. Patches
  2. Hooks