Giter Club home page Giter Club logo

bga-innovation's Introduction

bga-innovation

Development flow:

In order to test changes to the game, you need to be able to copy the code out of our GitHub repository and into a personal BGA project and then back again.

Prerequisites

Setting up your branch

In order to submit changes to this repository you will need to eventually submit a pull request with your changes. This means you need to have your own local branch. Before running the following commands, make sure you are on the branch of this repository that you want to diverge from (e.g. main) and that you have called git pull so that you have the latest changes.

git branch johnsmith
git checkout johnsmith

Copying to your project

Use the bgaprojectrename.php script from the https://github.com/elaskavaia/bga-sharedcode repository you cloned. For example, if your BGA project is named InnovationJohnSmith, you would call a command like:

php bga-sharedcode/misc/bgaprojectrename.php innovation innovationjohnsmith 

WARNING: In order for the script to work correctly, the directory containing our repository should be named innovation not bga-innovation.

Make your changes

Make all of your changes in this other directory (e.g. innovationjohnsmith), testing them on https://studio.boardgamearena.com/ by pushing them to your BGA project. This can be accomplished by using the SFTP extension in VSCode, for example.

Copying from your project

After you've tested your changes, copy the changes back to your local branch in our repository.

php bga-sharedcode/misc/bgaprojectrename.php innovationjohnsmith innovation  

Creating pull request

Push your local branch into the GitHub repository.

git push -u origin johnsmith

Then navigate to https://github.com/elaskavaia/bga-sharedcode/pulls, click "New pull request", and follow the prompts there.

Tips and Tricks

  • If you are using the SFTP extension in VSCode to sync code to your BGA project, set up your sftp.json file something like the following, replacing johnsmith and password as appropriate.
{
    "name": "BGA",
    "host": "1.studio.boardgamearena.com",
    "protocol": "sftp",
    "port": 22,
    "username": "johnsmith",
    "password": "password",
    "remotePath": "/innovationjohnsmith/",
    "uploadOnSave": true,
    "ignore": [
        ".vscode",
        ".git",
        ".DS_Store",
        "misc/"
    ]
}

bga-innovation's People

Contributors

micahstairs avatar normaljosh avatar jacksonmead avatar tadodger 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.