Code Monkey home page Code Monkey logo

games-amazon-gamelift-testing-toolkit's Introduction

Amazon GameLift Testing Toolkit

aws provider Build status

A test harness and visualisation tool for Amazon GameLift and Amazon GameLift FlexMatch. The toolkit lets you visualise your GameLift infrastructure, launch virtual players, and iterate upon your FlexMatch rule sets with the FlexMatch simulator.

📜Documentation

Whether you're starting development of a multiplayer game with dedicated servers, or have already written a game using Amazon GameLift, you can quickly get the Amazon GameLift Testing Toolkit deployed and running.

The quickest way to get started is to build and deploy the toolkit and the sample game, and you can then delete the sample game when you no longer need it.

Prerequisites

Additionally, if you intend to deploy the sample game or create virtual players you will also need:

  • Docker installed and you should be logged in to Docker Hub.

Bootstrap

yarn bootstrap

Build

dotnet tool install -g Amazon.Lambda.Tools
sudo npm install --global yarn
yarn
yarn build-toolkit

Optionally, if you want to deploy the sample game you should run:

yarn build-sample-game

Deployment

If you have configured the AWS CLI with multiple profiles you can pass in a name to choose which profile to target.

yarn deploy-toolkit [--profile <profileName>]

When the deployment succeeds succesfully the terminal will display a number of output variables. Make a note of the value of the AmazonGameLiftTestingToolkit.CloudfrontDomainName variable and the AmazonGameLiftTestingToolkit.userPoolId variable, which you will use in the next stage.

Optionally, if you want to deploy the sample game you should run the following command:

yarn deploy-sample-game [--profile <profileName>]

First time login

The toolkit uses Amazon Cognito to authenticate and authorize access to its web console, so prior to logging in you will need to create a user in the toolkit's Cognito User Pool.

  1. Login to the AWS Management Console and navigate to Cognito
  2. In the list of User Pools select the User Pool with the userPoolId you previously noted.
  3. In the Users tab, choose Create user.
  4. In Users and groups select Create user and then enter your user details.

Once you've created a user, you can login by navigating to the URL previously noted in the AmazonGameLiftTestingToolkit.CloudfrontDomainName variable.

Other Useful commands

  • yarn delete-toolkit Remove the toolkit from your AWS account
  • yarn delete-sample-game Remove the sample game from your AWS account

Credits

License

This library is licensed under the Apache License, Version 2.0. See the LICENSE file.

games-amazon-gamelift-testing-toolkit's People

Contributors

amazon-auto avatar dependabot[bot] avatar eastonmaws avatar github-actions[bot] avatar joep1978 avatar stevehouel avatar tgreaves avatar ubiguchi avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.