Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

entm-template

Buy Me A Coffee

Starter template for building entm-core modules. Pre-configured TypeScript setup, correct build pipeline, and automatic registration with entm-core on resource start.


Prerequisites

  • entm-core installed and running on your server
  • Node.js + npm

Getting Started

1. Copy this template

Download or clone this repo and drop it into your resources directory. Rename the folder to whatever your module is called.

2. Install dependencies

npm install

3. Build

npm run build

4. Add to server.cfg

ensure entm-core
ensure your-module-name

entm-core must be ensured before your module.

5. Done

The loader script registers your module with entm-core automatically on resource start. Your systems are added to the world and will tick with every frame.


Development

Command Description
npm run build Build client and server bundles
npm run watch Rebuild on file changes
npm run typecheck Type-check without building

Structure

your-module/
├── src/
│   ├── client/
│   │   └── index.ts   — client systems + __registerModule call
│   └── server/
│       └── index.ts   — server systems + __registerModule call
├── loader/
│   ├── client.js      — tells entm-core to load this module (client)
│   └── server.js      — tells entm-core to load this module (server)
├── dist/              — compiled output (generated)
└── fxmanifest.lua

Writing Systems

See entm-core for full documentation on components, systems, shared components, and the module API.


Buy Me A Coffee

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages