Skip to content

Latest commit

 

History

History
83 lines (64 loc) · 4.84 KB

README.md

File metadata and controls

83 lines (64 loc) · 4.84 KB

HighScor

forthebadge made-with-python

License: MIT GitHub top language Code style: black standard-readme compliant PRs Welcome Travis CI build status Coverage Status

Python programs that save high scores to a file.

The basic idea is that you add games, scores, and associate those scores with players. Additional functionality has also been added, including settings, viewing scores by player as well as by game, and so forth. The program works by shelving files with the highscores in them and retrieving them when necessary (actually only once at the start of the program; they're re-shelved only when the user chooses "save and quit").

Table of contents

Background

This program was created originally as a response to the fact that the games on my calculator didn't have a good way to save highscores, and the eventual hope is that it will be able to have games write highscores to it (while still allowing manual addition of scores).

Install

You need python 3.x downloaded on your computer. Clone the project. If necessary, unzip it. Yep, that's it!

Usage

The project has two interfaces, currently only the text-based is working (API under development.)

Run the file marked highscor_cmdline.py however you run python files.

Running python files

If you're not familiar with python and don't know how to run a file, there are several options:

Text interface

Alright, you're ready to save some scores! The program uses a text based interface, but never fear, there's no need to memorize any commands. Everything you need to know will be on a menu right before the prompt. There are a few types of prompts: Regular menus:

    Main Menu
    0 - Save and exit
    1 - Add a game
Choice:

These ones are pretty self-explanatory, just enter the number that corresponds to the menu item you want, and then press enter.

Selection from a list/dictionary menus:

    List of games
    - 2048
    - t-rex game
Enter the name of a game to access that game:

You have to enter one of the items on the list in order to access it. Entering anything but an item on the list will result in the program telling you it's not a valid option. They might be case-sensitive (still working on that).

User input:

What is the name of this game?

These might be yes or no questions, requests for a name, or a number. The program should tell you if you enter an invalid value, and will otherwise proceed.

Enter-to-continue prompts:

Press enter to continue.

Just press enter to continue. These often occur right after printing output, to give you some time to look at the output before proceeding back to a menu.

And that's all you need to know to navigate the program! If you're still confused, you can check out the wiki on this repo's Github page.

Versioning

The project was originally programmed without git, so the file marked old_version_history still has some of the version history. The file included here has the current version (v1.3.3).

Contributing

More than welcome! Please create issues/PRs for anything you think should be included that isn't. (Or bug/typo fixes, etc.)

Note: This repo conforms to the following styleguides; please comply: standard-readme and black.

License

MIT License © Harrison Payne. See license in LICENSE.md