Coder Social home page Coder Social logo

techies's Introduction

Setting environment variables

First, we need to make sure that all the required API keys are added to your environment variable. These include:

  • OpenAI API Key: For using openAI LLM models
    export OPENAI_API_KEY=<Your API Key>
  • Agentops AI Key: For agents' monitoring, testing and debugging
    export AGENTOPS_API_KEY=<Your API Key>
  • Freesound API Key: For downloading sound resources
    export FREESOUND_CLIENT_API_KEY=<Your API Key>

Usage

  • To install the package

    $ VERSION=0.1.2
    $ pip install git+https://github.com/kd-research/Techies.git@${VERSION}
  • Show avaliable crews

    $ techies list_crews
  • Show help on specific crew

    $ techies help `crew_name`
  • To run the crew

    $ techies --ai openai run hierarchy_crew_v2 --game Wordlenew_game_specifications

Developing Techies

To compile

Follow these steps to compile the project locally:

# Clone the latest code from the remote branch
$ git clone https://github.com/kd-research/Techies.git
# Move to the root director
$ cd Techies
# Compile the code
$ pip install -e .

As long as no error appears, it means all the dependencies have been met, and the code is good to go!

To run

Follow these steps to run Hierarch Crew (game tree) and/or HTML Crew (coding):

# Create a new working directory in the root and move there
$ mkdir working_dir
$ cd working_dir

For Hierarchy Crew

  • Use the following command to run the hierarchy crew

    $python ../techies/cli.py --ai `LLM_MODEL` run hierarchy_crew_v2 --game `GAME_SPECS` 

    Here is a sample run:

    $ python ../techies/cli.py --ai openai run hierarchy_crew_v2 --game Wordlenew_game_specifications
  • You can choose an exisiting game specification or add a new one in the same file.

  • The hierarchy crew will generate a game_hierarchy.xml (game tree file), in the current working directory (e.g., inside working_dir/)

For HTML Crew

  • Use the following command to run the HTML crew

    $ python ../techies/cli.py --ai `LLM_MODEL` run html5_crew

    Here is a sample run:

    $ python ../techies/cli.py --ai openai run html5_crew
  • HTML crew assumes that there is a game_hierarchy.xml file exist in the current working directory (e.g., working_dir/game_hierarchy.xml).

  • The HTML crew will generate a couple of files as output in the current working directory (E.g., inside working_dir/). These include:

    • index.html
    • style.css
    • script.js
    • game.html (combines index.html, style.css, and script.js)
    • *.mp3 (sounds files)
  • You can run the game by either running game.html or index.html

techies's People

Contributors

hukaidong avatar usmannn avatar rsarder avatar wcchandler99 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.