Skip to content
This repository was archived by the owner on Mar 31, 2020. It is now read-only.

thoughtful_termites

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

thoughtful_termites

README.md

Savanna

A project by Thoughtful Termites (@mathsman, @meta, @hanyuone) for Code Jam 5

Welcome to Savanna, our application that helps you, the user, to become more eco-friendly by setting environmentally green goals.

Installation and Setup

  1. Install pipenv and run pipenv install on the project.

  2. Run __main__.py to start the control panel.

  3. Configure the bot using the 'Configure Bot' button. This will require you to set up your own Discord bot here. Enter in the bot's token and client ID as prompted. NOTE: You need to create a new server and invite the bot to that server to run commands.

  4. Configure goals and reminders using the 'Open Goals' button. More info on this in the Usage section below.

  5. Run bot using the 'Start Bot' button.

Goals

  1. Launch the goals list via the control panel and create a goal, with a custom description. If you can't think of any ideas, you can press a button for the app to suggest a goal for you.

  2. You can set reminders for any environmental goal that you have by right-clicking it and selecting "Edit Reminders". To add a reminder on a daily basis, the 'Add Daily Reminder' button is provided for convenience.

  3. You may customise your goals and reminders by selecting one or more, right clicking and choosing "Edit". You can also delete them by selecting "Delete".

  4. Once you believe you have completed your goal, select "Complete Goal" after right-clicking it. This will accrue points used to unlock mini games.

  5. After you have finished a certain number of goals, you can go to the "Unlocks" window to unlock various minigames or features, accessible on the Discord bot. This is accessible from the 'Unlock Minigames' button at the Control Panel.

Minigames & Features

We have a large variety of minigames and features on our Discord bot, including:

  • >trivia: A general trivia game that tests the user's knowledge.

  • >reacttest: Test your reaction speed with this minigame!

  • >farmertown: Are you the best farmer in the town?

    Play a game of FarmerTown with the bot. This game is complex - read carefully!

    • You can sow a crop every 12 hours
    • You can get the results of that crop 12 hours later
    • Each crop has differing levels of drought risk, and germination rates. Generally, the higher the risk, the higher the profit.
    • The aim of the game is to get the most money.
    • If a drought occurs, the germination rate is 0, and the profit is 0. Costs are the same.
    • Costs are calculated by the raw cost of the crop * the tonnes put in
    • Profit is calculated by the sale price * tonnes put in * germination rate.

    How to get started:

    • Create an account with >farmertown create
    • See a list of crops to plant with >farmertown croplist
    • Sow a crop with >farmertown sow CROP_NAME_HERE
    • Wait 12 hours
    • Find the results of the crop and add this to your bank balance with >farmertown results
    • Repeat!
    • Check your balance with >farmertown balance

Some minigames are available once you finish a certain number of goals:

  • >climate_commentary (1 goal): Offers a variety of different comments in regards to the wide subject of climate change.
    • >climate_commentary x: Select a specific piece of commentary with an ID of x.
  • >rankings (2 goals): Rank five separate countries by their contribution to climate change.
  • >hangman (4 goals): Guess the letters in a mystery word, but be careful not to guess incorrectly!
    • React with the regional indicator emoji to guess a letter.
  • >treefinder (8 goals): Find the trees in a mystery field, but don't accidentally remove the trees!
    • Use guess x y to excavate a tile on the field.
    • Use flag x y to flag a certain tile.

Code Jam-specific stuff

  • If you want to bypass the unlocks, edit the file shared/goal_db/completed_goals.txt to any number above 8. If no such file exists, create one and put any number above 8 in.

  • You can disable the cooldowns imposed upon >farmertown sow and >farmertown results with >farmertown ignore_cooldowns. Less fun, but it makes testing easy...

Credits

Program icon courtesy of Vignesh P, accessed via https://www.iconfinder.com/icons/2189582/ecology_green_leaf_plant_spring_icon

Released under the Creative Commons Attribution 3.0 Unported license. https://creativecommons.org/licenses/by/3.0/