Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Frostfire Forge Plugin Template

A bare-bones starter template for creating Frostfire Forge plugins.

What it does

Listens for PLAYER_CHAT events and logs every chat message to the server console.

Structure

Frostfire-Forge-Plugin-Template/
  manifest.json   - Plugin metadata (name, version, entry point, provides)
  types.d.ts      - Plugin-local type declarations
  src/
    index.ts      - Entry point (register/unregister)

Plug into Frostfire Forge

Drop this folder into the Frostfire Forge engine's src/plugins/ directory. The plugin loader scans for manifest.json files in subdirectories and loads them on server start.

Register hook

const plugin: GamePlugin = {
    async register(engine: EngineAPI, manifest: PluginManifest) {
        // Subscribe to engine events here
    },
    async unregister() {
        // Cleanup here
    },
};
export default plugin;

Available engine events

See src/systems/events.ts for the full list of events your plugin can hook into (PLAYER_CHAT, PLAYER_DEATH, SPELL_CAST, WARP, MAP_ENTER, etc.).

About

A plugin template for Frostfire-Forge that logs chat messages to the console.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages