planet-lia / planet-lia

A platform for bot programming competitions.

Planet Lia

Planet Lia is a bot programming platform for beginners and advanced coders alike, where you can use your coding skills to develop a bot for our video games and battle with it against other enthusiastic coders. Improve your coding skills, join the community and have fun!

NOTE: We are still in the process of rebranding from Lia Game to Planet Lia and some inconsistencies may still be present in this repository. You are welcome to open a GitHub issue spotting any inconsistencies so that we do not overlook them.

Our Vision

With Planet Lia we want to build an open and friendly community and hub for bot programming video game competitions. Our goal is to provide the supporting technological as well as community infrastructure so that coders can enjoy in Planet Lia games as well as easily create their own game challenges and share them with others. Our goal is to build a community where programming is a way to connect with people, to bring fun and creativity to programming, have some healthy competition and learn from one another.

About the Repository

This is a single monorepo that holds everything related to the Planet Lia platform. Here is a quick overview of the structure of the repository:

• backend - infrastructure that takes care of the user data, uploaded bots, generates matches, builds leaderboards and much more
• cli - a tool that runs on your local machine and helps you develop your bots for Planet Lia games
• game-utils - a set of tools that help game creators develop their Planet Lia games as effortlessly as possible
• games - a collection of all available Planet Lia games
• websites - code for our main Planet Lia website, the documentation and other important parts made for the web

⚠️ We are still in process of open sourcing the whole Planet Lia platform and not all of its parts are already present in this repository. We will add the remaining parts as soon as we clean them up. In the current state you unfortunately can't build and run a full platform locally.

Code of Conduct

When participating in the Planet Lia community please follow our Code of Conduct.

Contributing

We are a small team behind this project and we really appreciate all the help from the community. There are many different ways that you can help the project:

• 🐛 Submit bugs and 🌟 feature request
• 📚 Help with the documentation - we have large amounts of documentation that take a lot of time and effort for us to write and curate. Help is greatly appreciated!
• 🔧 Contribute code - let's build the core Planet Lia platform together
• 🎮 Create your own game (WIP) - you will be able to code your own game and publish it on Planet Lia platform where others will be able to compete in it. If you want to learn more then come and chat with us on Discord where we will gladly tell you more.

Learn how to contribute in our Contributing Guide.

Join the Community

• Join our Reddit forum
• Chat with us on Discord
• Follow us on Facebook
• Send us an email at [email protected]

About Us

We are three students of Computer Science at the University of Ljubljana, Slovenia and we all love coding, collaborating, meeting new people and having some healthy and fun competition while improving our skills. We started working on Lia in early 2018 as a hobby project but it has since evolved into a fully fledged platform for bot programming video game competitions. We are working on Lia in our spare time so any help is appreciated!

planet-lia's Issues

GitHub Actions failing with commenting to PR

Expected Behavior

Actions bot should post Netlify deploy preview comment.

Current Behavior

Action fails.

Context

#70

Match generator debug view controlls

Summary

Debug view controls (play, pause, speed).

Debug log window for base match-generator

Summary

In debug mode bot developer can follow API calls and responses for all connected bots.

GitHub actions triggering incorrectly

Expected behavior

For #49 no action should be triggered.

Current behavior

Actions for web/main and web/docs were triggered.

Online editor Docker container image

Summary

Docker container image to run matches from the online editor. The image will accept source code and it should inject it into the bot implementation and run the game outputting the stdout/stderr as well as the final replay file.

Newsletter form on main website fails with no visual error/warning due to Firefox content blocking

When subscribing to the newsletter on the main page, if the user's browser has content blocking enabled for trackers the subscription form breaks and gives the user no visual feedback something is wrong.

Error in console:

Although I have custom preferences for content blocking, Firefox has enabled Enhanced Tracking Protection on by default in new versions of Firefox. Therefore this could become an issue down the road.

Expected Behavior/Solution

Detect if content blocking is enabled (the HTTP request fails); display a warning, disable submission button and maybe instructions on how to add it to the exception list.

Current Behavior

The user receives no visual indication something is wrong, the form does nothing after clicking on subscribe.

Your Environment

Firefox macOS 69.0 (custom content blocking preferences with trackers and cookies blocked)

Backend support for Discourse

Summary

Support Discourse. 😛

Add default Python3 support

Support for teams of bots in match-generator

Summary

Add an option to specify the details about how many bots are in the match, how many teams they form and how big each team is.

Add default Kotlin bot

Generic config support in match-generator-base

Summary

Load config from a specific folder, the same as where assets will be placed.

Epic: DevOps

Help to make developers life easier.

CI/CD

• Github actions when commited to master (#29, #30, #31)
• Backend services test and deploy
• Website test and deploy
• Documentation test and deploy
• Games test and deploy
• Infrastructure files deploy
• CLI test, build and create a new release
• Game utilities - test, build and deploy libraries to remote center (eg. Maven central)

Monitoring

• Unified logs view across all services
• Monitoring dasboard (performance, health, ...)
• Alerting

Main website does not serve 404 pages

Expected Behavior

When visting e.g. https://planetlia.com/this-should-be-a-404 the page should return a 404 page.

Current Behavior

The router ignores the invalid page and serves the main (index) page.

CLI bot commands for a specific game

Summary

• Download and name the bot
• Build the bot
• Delete the bot

GitHub Actions path field change

Summary

Our rant regarding the way GitHub Actions handle path triggers was a success!

In case GH Actions yml format changes, we need to fix our workflows do they don't break.

Multiple bots support in base match-generator

Summary

Add tools to connect any number of bots to the base match-generator, send them data and receive their responses.

Match generator debug mode disable bot restrictions

Summary

Bots shouldn't timeout in debug mode.

Remove reddit from main README.md

Summary

Remove reddit badge from main README.md file.

Online editor endpoint to submit code

Summary

GraphQL endpoint to submit code for the online editor.

Epic: Local bot development

Improve CLI to support multiple Planet Lia games and better bot development workflow.

CLI (.lia)

• Support multiple games
• Use a web based replay viewer
• Move prepare, cleanup and run configurations to bot implementations
• List of CLI commands (WIP):
  • game #103
    • download - relative to cli
    • list
    • update
    • delete
    • automatically check for game updates
  • bot - uses pwd
    • new #104
    • build #104
    • update (is it worth it?)
    • delete #104
    • clean
    • upload
  • play ... [--game-path-manual] [-r replay-file-path] - if -r is not provided, the replay file is stored in replays/game-name/ relative to the cli location #106
  • replay [-f file-name]
    • Without provided file opens up a local match-viewer with index of all replays (live refresh) #105
    • Match viewer API:
      • List all replay files
      • Return selected file
      • List a specific file
    • Opens a specific replay file
  • prune [-y] [game-name]
  • help
  • settings
  • account
    • login
    • logout
    • status
  • gzip
  • update - get all the details from a repository cli-details.json config

Local Match Viewer

• Create the site and integrate match viewer in it
• Load replay files from local os
• List all replay files

Write bot runtime stats to replay

Summary

Write bot runtime stats to replay file (standarize it!). Examples: number of timeouts, was it disqualified, disqualification time, response total duration, disqualification reason, team index

Setup basic infrastructure

Summary

Setup basic Kubernetes cluster for new infrastructure.

CI/CD welcome and introduction comment bot on new first time author pull request

Summary

When a newcomer opens his first pull request on the repository, the bot could welcome him to the project and give a short introduction regarding the code style, contribution guidelines, etc.

We could use GitHub's First Contribution Action.

Replace html web-main placeholder with React app

Summary

Use React for web-main.

Game commands for CLI

Summary

• download
• list
• delete
• update

CI/CD for main website

Summary

Create a CI/CD pipeline to automatically deploy source from master to production web server.

This will probably be done using GitHub Actions + Netlify

Match generator extendable base entity

Summary

In debug mode on hoover it can display extra data.

Pass through bot details to bots

Summary

Pass through details to bots eg. who are their opponents and optionally ranks, link to external storage etc.

Use Netlify API to deploy instead of Netlify CLI in GH Actions workflow

Summary

Use Netlify's API to deploy instead of downloading & building the Netlify CLI. This would help us shave approx. 1 minute for website deploys.

Create backend project

Summary

Create the basic Go project with the root endpoint and appropriate Makefile.

CI/CD for backend

Summary

Create a CI/CD pipeline to deploy to our infrastructure.

This will include running unit tests, building the necessary Docker image and creating the necessary commit to our planet-lia/infrastructure repository.

Main loop with optional debug view

Summary

Bot developer can run match-generator instance with debug view that displays the match as it is generated.

Match generator replay files support

Summary

Add support to write and save replay files.

Bot restrictions in base match-generator

Summary

Specify bot restrictions to base match-generator and it will enforce them automatically.

Tests

• All bots not disqualified
• All bots disqualified
• Some bots disqualified
• Bot times out few time but not disqualified
• Bot times out and disqualified
• Trying to send multiple requests in same turn
• Trying to send multiple responses in same turn

Base match-generator LibGDX project

Summary

Create the main LibGDX project that every match-generator for every Planet Lia game will use.

Match viewer entering/exiting full screen occasional crash

Expected behavior

Match viewer should be able to enter or exit full screen.

Current behavior

Match viewer occasionally crashes when entering or exiting the full screen.

Context

It happens occassionally. Example error message:

Steps to reproduce

1. Start switching between full screen and non full screen mode

Your environment

Chrome, Linux (KDE Neon)

Contributing guide, set upstream not working

git branch --set-upstream-to=upstream/master doesn't work, tried on Windows.

Basic bot API

Summary

Short example in game-template of how to implement bot API.

Web-main move "What is Planet Lia?" section below image

Summary

On the main website move the section What is Planet Lia? between the image and Stay tuned....

Motivation

New users need to scroll to the bottom of the page to figure out what they are looking at.

Remove default bots and implement game-examples bot

Improve commit message examples in CONTRIBUTING.md

Check Angular gude and Angular commit messages.

Java generic bot

Summary

Create Java generic bot that can be used for any kind of Planet Lia game.

CI/CD for docs

Summary

Similar to #29, just for the docs webpage.

CI/CD automatic pull request labels based on project

Summary

We could include the actions labeler to automatically assign project labels to new pull requests.

Epic: Game dev framework

Create a game development framework which will help developers creating Planet Lia games to more easily create their own games.

Game (Example Game)

• Base LibGDX project #20
• Main loop that can run with or without (debug view) displaying the game #21
• Support any number of connected bots #22
• Bot restrictions support #23
• Add generic config support (loads a config) #35
• Generic way of getting game state every tick (for custom tools) - Discord request #40
• Add support for teams of bots #42
• Pass through bot details to bots eg. who are his opponents and optionally ranks, link to external storage etc. #43
• Log window in debug view where bots can write their logs #24
• Debug view controls (play, pause, speed) #78
• Debug view disable bot restrictions #79
• Base entity that devs can extend and that can display entity details on hover #80
• Basic bot API #90
• Support for writing replay files #81
• Write bot runtime stats to replay file (standarize it!). Examples: number of timeouts, was it disqualified, disqualification time, response total duration, disqualification reason, team index #82
• Rename game-template to game-example #96
• Remove default bots and implement Java and Kotlin for this example #97
• Document game-example #83

Game Utils

• Match viewer remove the need to specify file type (gzip, json, zip)
• Export generic functions to library #98
• Document library
• Refactor basic bot implementations to be generic for any game
  • Java #25
  • Kotlin #87
  • Python3 #88
• Tutorial on how to add new generic bot implementation for unsupported languages

Replay file examples

Examples where person can see the code, the replay json and what it does in the player

Entity Types

• TextureEntity
• TextEntity (text, time)
• ParticleEntity

Attribute Interpolation

• Linear Interpolation
• Step Interpolation
• Sine Interpolation
• Circular Interpolation
• Mixed Interpolation

Controlling entities

• Entity attributes (rotation, scale, texture swap, opacity, visibility)
• Multiple entities (obstacles)
• Layer attribute
• Entity animation
• Attach simple
• Attach rotation
• Attach rotation and angle
• Attach no scale
• Attach with scale

Camera

• Camera movement
• Multiple cameras
• HUD camera elements

Other

• Charts (statistics)
• Show entity path
• Match details

Way of listening to all requests sent to all bots

Summary

Make it possible to connect to match-generator and listen to all requests sent to all bots.

Motivation

It makes it possible to build better development tools.

Epic: Offline tournament environment

Support for generating local leaderboard and packing it with all games into a static html page.

Local Environment - Backend

• Map uploaded bots to usernames and emails
• Generate matches in parallel
• Store results of matches
• Keep track of the leaderboard
• Define matchmaking logic

Local Environment - Frontend

• Leaderboard page
• Games page
• Games page filter by user
• Deploy website

Configure feature flags for web-main

Summary

Setup the React part to support feature flags on the website.

Rename game-template to game-example

Summary

Rename game-template to game-example