Skip to content

Latest commit

 

History

History
253 lines (182 loc) · 7.7 KB

README.md

File metadata and controls

253 lines (182 loc) · 7.7 KB
Raw

Contributors Forks Stargazers Issues


Edgerunner


Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

product-screenshot

(back to top)

Built With

  • Ncurses
  • C
  • A lot of coffee

(back to top)

Getting Started

In order to compile and play edgerunner, you'll need the ncurses library installed on your computer. You'll also need the gcc compiler, gnu make and a shell language.

Most distros provide a package for the library. On some distros (notably gentoo), you'll have to replace the

-lcurses

flag by

-lncurses -ltinfo

in the src/makefile file.

Prerequisites

The only dependency that you might not have on you distro is ncurses. I don't guarantee that the code will work with a very old version of gcc.

  • gcc

  • make

  • ncurses

    • debian / ubuntu
        sudo apt-get install libncurses-dev
    • arch
        sudo pacman -S ncurses
    • void
        sudo xbps-install ncurses

Installation

  1. Clone the repo

    git clone https://github.com/k-avi/edgerunner.git
cd edgerunner

  2. you can use the build.sh script to compile edgerunner, add it to /usr/local/bin and add a manpage for edgerunner in /usr/local/share/man the script will also check for dependencies. If your linux does not have a /usr/local/share/man directory, the script won't create a man page. You can still copy manpages/edgerunner/man1/edgerunner.1 to your standard man location.

    sudo bash build.sh

  3. If you don't want to install edgerunner in /usr/local/bin , and want to create a binary simply type

    make edgerunner

  4. If you built edgerunner with build.sh and want to remove it , use the uninstall.sh script.

    sudo bash uninstall.sh

(back to top)

Usage

product-screenshot1

To start a game, simply start the program. during the game, you are the @ symbol on the screen. You try to reach the % symbol by moving from node to node on a graph. You have to be careful and avoid the ennemy (or ennemies) represented with the ! character. The node where the exit is is colored in green , the node where the player is is colored in blue, the nodes where the ennemies are are colored in red.

In order to move from your node to another, type the number appearing on the node. Good luck !

product-screenshot1

For more informations, please refer to the manpage of the game or use the -h options

(back to top)

Roadmap

  • Items / special nodes
  • Score enhancement (better score system and score saving)
  • Screensaver mode
  • Make it so the ennemy still appears when it's on the exit node
  • Fix spawn kill issues

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the free software community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the GPLv3 License. See LICENSE.txt for more information.

(back to top)

Contact

I.M-R - [email protected]

Project Link: https://github.com/k-avi/edgerunner

(back to top)

Acknowledgments

(back to top)