Skip to content

創建新的 Colyseus 伺服器

需求:

從 NPM 樣板創建 Colyseus 伺服器

使用 npm init colyseus-app 命令創建新的 Colyseus 伺服器. 您可以選擇 TypeScript (推薦) 和 JavaScript 作為伺服器語言. Arena Cloud 目前僅支持兩種語言.

npm init colyseus-app ./my-colyseus-app

NPM Selection

  • 目前僅支持編譯後的 TypeScript 和 JavaScript (CommonJS) . 不久後會支持 ESM.

以下是在 my-colyseus-app 為 TypeScript 伺服器創建的目錄結構和文件.

NPM Code

  • index.ts / js: 此文件用於本地測試或自托管. 為確保 Arena Cloud 兼容性, 我們 建議 您 不要 直接對 index 文件進行更改. 伺服器托管在 Arena Cloud 上時, 您對此文件的變更和功能更新都不會生效. 做本地測試時可以變更此文件裏面的 Colyseus 伺服器端口.

  • arena.config.ts / js: 可以在此文件中進行變更和功能更新, 以便更好地支持您的遊戲. 請註意在伺服器初始化時需要調用的三個核心函數.

    getId: () => "Your Colyseus App",

    initializeTransport: (options) => {
        /**
         * 定義服務器傳輸層為 uWS (新版)
         */
        return new uWebSocketsTransport({});

        /**
         * 定義服務器傳輸層為 WS (舊版)
         * 本地開發時如果使用舊版 WS 需提供如下配置,
         * Arena 上並不需要這些配置
         */
        // return new WebSocketTransport({
        //     ...options,
        //     pingInterval: 5000,
        //     pingMaxRetries: 3,
        // });
    },

    initializeGameServer: (gameServer) => {
        /**
         * 定義房間句柄:
         */
        gameServer.define('my_room', MyRoom);

    },

    initializeExpress: (app) => {
        /**
         * 自定義 express 路由位址:
         */
        app.get("/", (req, res) => {
            res.send("It's time to kick ass and chew bubblegum!");
        });

        /**
         * 綁定 @colyseus/monitor
         * 建議使用密碼把這個路由位址保護起來.
         * 詳見: https://docs.colyseus.io/tools/monitor/
         */
        app.use("/colyseus", monitor());
    },


    beforeListen: () => {
        /**
         * 在執行 gameServer.listen() 之前自動調用此函數.
         */
    }

  • arena.env / development.env: 這些文件用於管理 Colyseus 伺服器的環境變數, 在 Arena Cloud 上托管時, 默認加載 arena.env.

  • lib / upload Folder: 只有在第一次執行 npm run build 命令時才會創建此文件夾. 此文件夾包含了需要上傳到 Arena Cloud 的文件, 包括編譯後的 JS 代碼, package.json 和 .env 文件.

Back to top