README.md

R^3 Engine

---

R^3 is the third and latest game engine for Flash Flash Revolution, a free online rhythm game that has been played by over 2 million registered users since 2002.

More images!

---

Table of Contents

• R^3 Engine
  • Table of Contents
  • Getting Started
    • Prerequisites
    • Fork the Repo
    • Configure Git
    • Clone your Repo
    • Bootstrap the AirSDK
      • Running the Script
    • Create custom Workspace
    • Install Workspace Extensions
    • Use AIR SDK
    • Build Fonts
    • Debugging
  • Contributing
  • Packaging
  • Contact
  • Contributors ✨

---

Getting Started

These instructions will get you a copy of the R^3 Engine up and running on Windows for development and testing purposes (Mac and Linux are not supported).

Prerequisites

• Visual Studio Code
• Git for Windows
• Java Runtime Environment
• Adobe AIR SDK & Compiler (v32.0.0.116 is the final Adobe release)
  • Extract the contents of the zip folder to your computer

Fork the Repo

Click the Fork button in the header of this repo before continuing. When it's finished, you'll be taken to your copy of the repo.

Configure Git

• Open Visual Studio Code.
• Press Ctrl+` to open the terminal.
• Paste the following command:

git lfs install; git config core.ignorecase false

Clone your Repo

Next you'll need to clone your forked repo to your computer:

• Press CTRL+SHIFT+P and search for Git: Clone.
  • Enter https://github.com/YOUR_GITHUB_USERNAME/rCubed.git.
• If successful, a popup will prompt you to open the cloned repo.

Bootstrap the AirSDK

This prevents an inconsistent compiler error caused by bad air tooling.

Running the Script

• Pressing the Windows key.
• Typing powershell.
• Hit enter or click on the application.
• Navigate to your repository directory.
  • ex. cd L:\git\flashflashrevolution\games\rCubed
• Run the bootstrapper
  • ex. .\bootstrap.ps1 "C:\airsdk\32.0.0.116\frameworks\flex-config.xml"

---

Create custom Workspace

In order to setup the SDK path locally in a later step, you'll create a custom workspace from the template.

• Make a copy of the r3.code-workspace file alongside it, in the root folder.
• Rename the new workspace to anything else but keep the same extension (for example my-workspace.code-workspace).

Install Workspace Extensions

• Open your workspace file.
• A popup will prompt you to automatically install the recommended extensions (You can install them manually by pressing CTRL+SHIFT+X and searching).
  • ActionScript & MXML
  • Actionscript Tools

Files with the .as extension will now automatically format on save (You can manually format by pressing ALT+SHIFT+F).

Use AIR SDK

• Press CTRL+SHIFT+P and search for ActionScript: Select Workspace SDK.
  • Select Add more SDKs to this list... then select your unzipped folder.

Build Fonts

• Press CTRL+SHIFT+B and run ActionScript: compile release - fonts/asconfig.embed-fonts.json.

Debugging

• Press F5, and the R^3 Engine will launch in Debug mode.

---

Contributing

Please read through the FFR Contribution Guidelines before opening a pull request.

---

Packaging

In order to package your app, AIR needs a certificate. Run GenerateCertificate to create it.

---

Contact

To contact a member of the FFR development team:

• Join the FFR Discord and post in the #dev-chitchat channel.
• Open an issue on GitHub.
• Private message a developer on FFR.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Fission 📖	G-flat 🐛 🤔 💻 📖 🌍	Hakulyte 🐛 🤔 🌍	Jaemin Choi 🌍	Justin 🐛 💻 🤔	Max Proske 💻 🤔 🐛	Oppiie 🐛 🤔 🌍
Psycast 💻 🤔 🐛 📖 🚧	Salem Kallien 🐛	SmexxxyBeast 🤔	Snupeh 🌍	SoFast 💻	Sploder12 💻	TCHalogen 🐛 🤔 💻
Zageron 💻 🤔 🐛 📖 🚇 🚧 🧑‍🏫 📆 👀 🔧	arcnmx 💻 🤔 🐛	goldstinger 🐛 🌍	nse_ 🌍	qrrbrbirbel 🤔 🐛	silentsputnik 🤔

This project follows the all-contributors specification. Contributions of any kind welcome!