# Packages
# README
nano 
Nano is an simple, fast and lightweight game server framework with clustering support and client libraries for iOS, Android, Unity and others through the C SDK. It provides a basic development framework for distributed multiplayer games and server-side applications.
Getting Started
Prerequisites
- Go >= 1.16
- etcd (optional, used for service discovery)
- nats (optional, used for sending and receiving rpc)
- docker (optional, used for running etcd and nats dependencies on containers)
Installing
clone the repo
git clone https://github.com/nut-game/nano.git
setup nano dependencies
make setup
Hacking nano
Here's one example of running nano:
Start etcd (This command requires docker-compose and will run an etcd container locally. An etcd may be run without docker if preferred.)
cd ./examples/testing && docker compose up -d etcd
run the connector frontend server from cluster_grpc example
make run-cluster-grpc-example-connector
run the room backend server from the cluster_grpc example
make run-cluster-grpc-example-room
Now there should be 2 nano servers running, a frontend connector and a backend room. To send requests, use a REPL client for nano pitaya-cli.
$ pitaya-cli
Pitaya REPL Client
>>> connect localhost:3250
connected!
>>> request room.room.entry
>>> sv-> {"code":0,"result":"ok"}
Running the tests
make test
This command will run both unit and e2e tests.
Contributing
#TODO
Authors
- TFG Co - Initial work
License
Acknowledgements
- nano authors for building the framework pitaya is based on.
- pomelo authors for the inspiration on the distributed design and protocol
Security
If you have found a security vulnerability, please email [email protected]
Resources
-
Other pitaya-related projects
-
Documents
-
Demo