sonolus-express v6.3.1

sonolus-express

TypeScript based developer toolkit for Sonolus servers with Express.js.

Links

• Sonolus Website
• Sonolus Wiki
• sonolus-pack

Features

• Setup all necessary routes automatically, compliant with Sonolus server specifications.
• Provide handlers to interact with each route.
• Load packs created by sonolus-pack.

Installation

npm install sonolus.js --save

Example

const port = 3000
const app = express()

new Sonolus(app).load('pack')

app.listen(port, () => {
    console.log('Server listening at port', port)
})

Documentation

Sonolus

constructor(app, options)

Create a Sonolus server on app with options.

• app: Express.js app.
• options.version: allowed Sonolus version.
• options.basePath: base path of the Sonolus server.
• options.fallbackLocale: fallback locale when user's preferred locale cannot be used.

db

Sonolus database. Can be modified to dynamically add/remove/reorder items.

• db.levels: levels.
• db.skins: skins.
• db.backgrounds: backgrounds.
• db.effects: effects.
• db.particles: particles.
• db.engines: engines.

load(path)

Load a pack created by sonolus-pack.

• path: file path to the pack.

add(type, data, hash?)

Add a resource. Returns SRL which can be used to access the resource.

• type: resource type.
• data: data (Buffer) or file path (string) to the data.
• hash: (optional) hash of the resource, will be calculated automatically when omitted.

localize(text, locale)

Localize text using target and fallback locales.

• text: text to localize.
• locale: target locale.

serverInfoHandler

Handler for requesting server info. Defaults to defaultServerInfoHandler.

levelListHandler

Handler for requesting . Defaults to defaultLevelListHandler.

skinListHandler

Handler for requesting . Defaults to defaultSkinListHandler.

backgroundListHandler

Handler for requesting . Defaults to defaultBackgroundListHandler.

effectListHandler

Handler for requesting . Defaults to defaultEffectListHandler.

particleListHandler

Handler for requesting . Defaults to defaultParticleListHandler.

engineListHandler

Handler for requesting . Defaults to defaultEngineListHandler.

levelDetailsHandler

Handler for requesting . Defaults to defaultLevelDetailsHandler.

skinDetailsHandler

Handler for requesting . Defaults to defaultSkinDetailsHandler.

backgroundDetailsHandler

Handler for requesting . Defaults to defaultBackgroundDetailsHandler.

effectDetailsHandler

Handler for requesting . Defaults to defaultEffectDetailsHandler.

particleDetailsHandler

Handler for requesting . Defaults to defaultParticleDetailsHandler.

engineDetailsHandler

Handler for requesting . Defaults to defaultEngineDetailsHandler.

Using meta in TypeScript

Use declaration merging:

declare module 'sonolus-express' {
    interface LevelInfo {
        meta: ... // user-defined meta information type
    }
}