github.com/Laplace-Game-Development/Laplace-Entangled-Environment@v0.0.3/README.md (about)

     1  # Laplace-Entangled-Environment
     2  An out of the box backend service for games to create a client-based multiplayer game. Write the code once then spread it to other players without much knowledge of networking. 
     3  
     4  ## Setting Up The Project
     5  - Install GO
     6  - Install Redis
     7  
     8  ## Setting Up Node Layer
     9  The application will support running of different binaries to communicate with. This will represent the server code of a game. The current example in use is a NodeJS module.
    10  
    11  - Install NodeJS
    12  - `cd node-layer`
    13  - `npm install`
    14  - `cd ..`
    15  
    16  ## Setting Up Configurables
    17  - Create a TLS certificate in this directory
    18  `openssl req -new -newkey rsa:4096 -x509 -sha256 -days 365 -nodes -out tlscert.crt -keyout tlskey.key`
    19  
    20  ## Running the Project
    21  `go run ./cmd/main.go` will run the application
    22  
    23  ## Testing the Project
    24  This will run all tests associated with the application in the present working directory
    25  - For Windows: `go test ./... -v -args -cwd="%cd%"`
    26  - For Linux/OSX: `go test ./... -v -args -cwd="$PWD"`
    27  
    28  ## Documentation
    29  
    30  ### Refreshing Documentation for Project
    31  - For Windows: `gendoc.bat`
    32  - For Linux/OSX: `gendoc.sh`
    33  
    34  ### pkg.go.dev
    35  [Laplace-Entangled-Environment](https://pkg.go.dev/github.com/Laplace-Game-Development/Laplace-Entangled-Environment)