Cloudy Pad

Your own gaming box in the Cloud ! 🎮 ⛅

• Development status 🧪
• Features ✨
• Getting started 🚀
  • Installation
  • Create your Cloud gaming gear !
• Usage and configuration
  • Default specs
  • Box configuration format
  • Connect via SSH on Box
  • Set authorized SSH Keys
  • Setup a DNS record
• Supported gaming servers and Cloud providers
  • Cloud providers 🌥️
    • AWS
    • Azure (not yet implemented)
    • GCP (not yet implemented)
    • Other Cloud providers ?
  • Gaming servers
    • Wolf 🐺
    • Sunshine 🌤️
    • Other Gaming servers ?
• FAQ
  • How much will I pay ? 🫰
  • How does Cloudy Pad works?
  • Is it possible to deploy something else than Gaming servers ?
  • Will Cloudy Pad become a paid product ?
• License

Development status 🧪

This project is still at an experimental phase. While working and allowing you to play in the Cloud seamlessly, there may be breaking changes in the future. Feel free to contribute and provide feedback !

Features ✨

Compatible with Moonlight streaming client

Gaming servers:

• 🐺 Wolf
• (available soon) 🌤️ Sunshine

Cloud providers:

• AWS
• (available soon) Azure
• (available soon) Google Cloud

Getting started 🚀

Prerequisites:

• A Clouder account (eg. AWS)
• Make sure you understand the costs 💸 of running a gaming instance in the Cloud

Installation

Note: installation is very basic for now, requiring to clone Git repo and build app. I'm actively working on npm and other distribution methods (eg. static binary, container image).

Clone this Git repository:

git clone https://github.com/PierreBeucher/Cloudy-Pad.git
cd Cloudy-Pad

Build Cloudy Pad cloudypad CLI with either:

🐳 Docker or Podman

Run :

docker compose run cloudypad
podman-compose run cloudypad

You'll be dropped into a shell with ready-to-use cloudypad CLI.

🖥️ Build locally

Make sure to have installed:

• Pulumi 3.x or anterior
• NodeJS 18.x or anterior
• Typescript 5.x or anterior

Run:

npm install
npm run build
npm install -g

cloudypad CLI should now be available on path.

Create your Cloud gaming gear !

Deploy a Wolf server on AWS:

cloudypad deploy examples/gaming/wolf-aws.yml

Once your instance is deployed and ready, use Moonlight to access it. Get your instance IP or address with (it should be shown after deployment):

cloudypad get examples/gaming/wolf-aws.yml

Once Moonlight asks for PIN, open browser to PIN validation page with:

cloudypad utils wolf open-pin examples/gaming/wolf-aws.yml

Remember to stop or destroy your instance when done:

cloudypad stop examples/gaming/wolf-aws.yml

Start instance later with:

cloudypad start examples/gaming/wolf-aws.yml

Or destroy instance altogether (all data will be lost):

cloudypad destroy examples/gaming/wolf-aws.yml

Usage and configuration

Cloudy Pad uses YAML configuration to manage your gaming box via CLI. See examples configurations.

Basic commands:

# Show help
cloudypad --help

# Deploy a Box (provision + configure)
cloudypad deploy examples/gaming/wolf-aws.yml

# Provision a Box
# Only run infrastructure provisioning 
# such as AWS resource management
cloudypad provision examples/gaming/wolf-aws.yml

# Configure a Box
# Only run Box configuration (NixOS rebuild)
cloudypad configure examples/gaming/wolf-aws.yml

# Get a Box details
cloudypad get examples/gaming/wolf-aws.yml

# Destroy a Box 
cloudypad destroy examples/gaming/wolf-aws.yml

Default specs

Default configuration per provider:

• AWS: g5.xlarge instance (16Gb RAM, 4 CPU, NVIDIA A10G Tensor Core), 150Go Disk, dynamic IP allocation
• Azure (available soon): 150Go Disk, dynamic IP allocation, instance type to be specified
• GCP (available soon): 150Go Disk, dynamic IP allocation, instance type to be specified

Boxes are customizable to specify instance types, disk size, DNS record, IP configuration and more ! (See below)

Box configuration format

A box configuration is a YAML file looking like this:

# Unique name for your Box
name: cloud-gaming-gear

# The box Kind 
# Only gaming.Wolf is supported for now, but more will come gaming.Sunshine 
kind: gaming.Wolf

# Box specifications
# A few technical details to know where and how to deploy your Box
spec: 
  ssh:
    authorizedKeys: 
    - ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIGaNlYLbwtAmfcNjlOsP6Ryh3QxGn9qlhlQjPo5nbzBa
  provisioner:
    aws: {}

Connect via SSH on Box

Get your box details with:

cloudypad get examples/gaming/wolf-aws.yml
# Output something like

Then use ssh:

ssh root@<address>

Set authorized SSH Keys

Specify authorized SSH keys:

spec: 
  ssh:
    authorizedKeys: 
    - ssh-ed25519 AAA123...
    - ssh-ed25519 AAA456...

SSH keys will be added on next Box configuration.

Setup a DNS record

Note: you must own an Hosted Zone on the cloud Provider and have it configured accordingly. See provider doc for details.

spec: 
  dns:
    zoneName: gaming.crafteo.io

Will create a DNS A record pointing to your instance.

You can set detailed configuration:

spec: 
  dns:
    zoneName: gaming.crafteo.io

    # Will create record mybox.gaming.crafteo.io 
    # instead of record at root on gaming.crafteo.io
    prefix: mybox

    # DNS Record Time-To-Live in seconds
    # Default to 60
    ttl: 3600

Supported gaming servers and Cloud providers

Cloud providers 🌥️

For now only AWS is supported, more will come soon !

AWS

Set aws provisioner in your Box config:

spec: 
  provisioner:
    aws: {}

You can also override the underlying provisioner config:

spec: 
  provisioner:
    aws:
      # Set AWS region and other configs
      config:
        region: eu-central-1
      
      # Set instance details
      instance:
        staticIpEnable: true,
        rootVolume: 
          sizeGb: 500
          type: g5.2xlarge

Azure (not yet implemented)

Set azure provisioner in your Box config:

spec: 
  provisioner:
    azure: {}

GCP (not yet implemented)

Set gcp provisioner in your Box config:

spec: 
  provisioner:
    gcp: {}

Other Cloud providers ?

Indeed, AWS/GCP/Azure are expensive for a gaming box.

This project aim to support cheaper Cloud providers like Paperspace or TensorDock (if you're curious you can find an experimental Paperspace box hidden in the code, though it's not fully working yet). Do not to hesitate to contribute or ⭐ the project, it will help move things forward !

Gaming servers

Wolf 🐺

Wolf is an open source streaming server for Moonlight that allows you to share a single server with multiple remote clients in order to play videogames. It works via containers to provide various services such as Steam Big Picture.

Sunshine 🌤️

Sunshine is a self-hosted game stream host for Moonlight. You can install anything on your instance (eg. Steam or other) and stream it with Moonlight.

Other Gaming servers ?

This project intend to support Parsec. Feel free to propose other gaming servers !

FAQ

How much will I pay ? 🫰

Cloudy-Pad is free and open-source, however charges may apply when using a Cloud provider. Here's an estimation for AWS:

*Estimation based on eu-central-1 (Frankfurt) pricing in December 2023. Exact prices vary with time and regions.

This project's goal is to provide 20h / month for 20$ - Paperspace and TensorDock are good bets, but not ready to use yet.

Equivalent estimation for other providers will be added as they become ready.

How does Cloudy Pad works?

Deployment is divided in two phases:

• Provisioning: manage Cloud resources (virtual machines, firewall, volumes disks, etc.)
  • Currently managed via Pulumi
• Configuration: install everything on instance (gaming server, GPU drivers, etc.)
  • Currently managed via NixOS

A small framework, Cloudy Box, allow seamless integration of both technologies.

Is it possible to deploy something else than Gaming servers ?

Yes ! Underlying Cloudy Box framework is actually designed for that: easy deployment of Cloud infrastructure with NixOS (or other configuration tools). In the future it will be merged-out of this project to become a more generic Cloudy Box CLI and/or API project which Cloudy Pad will use.

If you're interested in these features, do not hesitate to reach me directly - my email can be found easily on my website crafteo.io.

Will Cloudy Pad become a paid product ?

Probably not in it's current form. Considering I'm really not happy about the enshittification of the internet, Cloudy Pad will remain FOSS - at least for personal use.

However, the larger Cloudy Box scope may become a paid product for professional use cases, not necessarily linked to gaming.

License

GNU GENERAL PUBLIC LICENSE