chrisrabe / bitburner-automation

Automation scripts I use for my Bitburner gameplay videos.
125 stars 41 forks source link

Enable repository to group episodes and include community scripts #10

Closed chrisrabe closed 2 years ago

chrisrabe commented 2 years ago

Background

I initially started the Bitburner Youtube series to help people get started with the game quickly. Never have I anticipated for it to gain the amount of views and engagement it currently has, or expected myself to be explaining intricate details of the code.

The more that I create videos and answer problems within the comment section, the more I realise that there's a gap in the amount of support provided for the game. Since we're all playing the same game and solving the same problems, then it makes sense for Bitburner players to have a central place to refer to for scripts.

There's a lot of players posting their Github links on Reddit, Discord or Steam, but I couldn't find a place that's dedicated to compile all of these resources together.

I decided that it might be valuable to make this repository as a "one stop shop" for all scripts created by myself and other players. I want to encourage anyone that's watching my videos to contribute in this repository and share their scripts for the benefit of everyone else playing that game.

Software development is a collaborative activity after all.

Changes needed

The folders will be shuffled into the following structure

root
 |- _stable
 |- episodes
      |- ep1
      |- ep2
      |- ...
 |- community
       |- README.md
       |- user1
       |- user2
       |- 
Folder Purpose
_stable Contains stable version of the scripts I use in my videos. Contains bug fixes for issues raised by the community
episodes Contains folders containing scripts that were created at the creation of the episodes. Subject to change due to bugs
community Contains folders that were created by other players and references to other Github repositories that can be used as references
chrisrabe commented 2 years ago

Change applied in PR #14