Commit 9915aece authored by Andrei Mihu's avatar Andrei Mihu
Browse files

Update readme.

parent fc91c0b8

README.md

+1 −1
Original line number Diff line number Diff line 
![Nakama](.github/logo.png?raw=true "Nakama logo")

======



[![GitHub release](https://img.shields.io/github/release/heroiclabs/nakama.svg)](https://heroiclabs.com/docs/nakama-download/)

[![GitHub release](https://img.shields.io/github/release/heroiclabs/nakama.svg)](https://heroiclabs.com/docs/nakama/getting-started/install/)

[![Forum](https://img.shields.io/badge/forum-online-success.svg)](https://forum.heroiclabs.com)

[![License](https://img.shields.io/github/license/heroiclabs/nakama.svg)](https://github.com/heroiclabs/nakama/blob/master/LICENSE)

sample_go_module/README.md

+4 −4
Original line number Diff line number Diff line
@@ -43,12 +43,12 @@ To setup your own project to build modules for the game server you can follow th 


    ```bash

    go mod init "plugin_code"

    go get -u "github.com/heroiclabs/nakama-common@v1.4.0"

    go get -u "github.com/heroiclabs/nakama-common@v1.23.0"

    ```



   ⚠️ __NOTE__: If you're working on Nakama's master branch drop the `@v1.4.0` from the above snippet.

   ⚠️ __NOTE__: If you're working on Nakama's master branch drop the `@v1.23.0` from the above snippet.



   ⚠️ __NOTE__: The official Nakama v2.11.+ expects nakama-common v1.4.0 in order to run. If you use v1.2.0, older, or drop the version reference, you might get a `plugin was built with a different version of package` error while starting up the nakama server.

   ⚠️ __NOTE__: The official Nakama v3.12.+ expects nakama-common v1.23.0 in order to run. If you use v1.22.0, older, or drop the version reference, you might get a `plugin was built with a different version of package` error while starting up the Nakama server.



4. Develop your plugin code (you can use the [minimal example](#minimal-example) as a starting point) and save it within your plugin project directory with the `.go` extension.
@@ -82,7 +82,7 @@ For Windows development and environments where you want to use our official Dock 


    ```bash

    cd "$HOME/plugin_code" # Your project folder. See instructions above.

    docker run --rm -w "/builder" -v "${PWD}:/builder" heroiclabs/nakama-pluginbuilder:2.11.1 build -buildmode=plugin -trimpath -o ./modules/plugin_code.so

    docker run --rm -w "/builder" -v "${PWD}:/builder" heroiclabs/nakama-pluginbuilder:3.12.0 build -buildmode=plugin -trimpath -o ./modules/plugin_code.so

    ```



   In the command above we bind-mount your current folder into the container and use the Go toolchain inside it to run the build. The output artifacts are written back into your host filesystem.