Skip to content

Create an empty Colyseus server project ready to bring your own implementation

License

Notifications You must be signed in to change notification settings

colyseus/create-colyseus-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

72 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

create-colyseus-app

An npm init template for kick starting your Colyseus server.

⚔️ Usage

npm create colyseus-app@latest ./my-server

Structure

  • index.ts: main entry point, register an empty room handler and attach @colyseus/monitor
  • MyRoom.ts: an empty room handler for you to implement your logic
  • loadtest/example.ts: scriptable client for the loadtest tool (see npm run loadtest)
  • package.json:
    • scripts:
      • npm start: runs ts-node index.ts
      • npm run loadtest: runs the @colyseus/loadtest tool for testing the connection, using the loadtest/example.ts script.
    • dependencies:
      • colyseus
      • @colyseus/monitor
      • express
    • devDependencies
      • ts-node
      • typescript
      • @colyseus/loadtest
  • tsconfig.json: TypeScript configuration file

License

MIT