A Nix-friendly SQLite-enhanced fork of Flitter, a speedrunning split timer for Unix-style terminals
| Revisão | 1136943f46b110d4fbe690561d9f54010c1d1eba (tree) |
|---|---|
| Hora | 2023-05-17 03:10:49 |
| Autor | Corbin <cds@corb...> |
| Commiter | Corbin |
Clean up docs.
| @@ -1,6 +1,6 @@ | ||
| 1 | 1 | MIT License |
| 2 | 2 | |
| 3 | -Copyright (c) 2018 Alex Ozer | |
| 3 | +Copyright (c) 2018 Alex Ozer, 2022 Corbin Simpson | |
| 4 | 4 | |
| 5 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy |
| 6 | 6 | of this software and associated documentation files (the "Software"), to deal |
| @@ -1,6 +1,8 @@ | ||
| 1 | -# Flitter | |
| 1 | +# Flitterite | |
| 2 | 2 | |
| 3 | -A Livesplit-inspired speedrunning split timer for terminal / command-line. | |
| 3 | +Flitterite is a Livesplit-inspired speedrunning split timer for terminals, | |
| 4 | +including several command-line tools for managing a database of splits. | |
| 5 | +Flitterite is forked from [Flitter](https://github.com/alexozer/flitter). | |
| 4 | 6 | |
| 5 | 7 |  |
| 6 | 8 |
| @@ -13,67 +15,36 @@ A Livesplit-inspired speedrunning split timer for terminal / command-line. | ||
| 13 | 15 | - 24-bit terminal color |
| 14 | 16 | - Undo / delete split |
| 15 | 17 | - Pause / resume |
| 16 | -- Splits and history stored in single human-editable file | |
| 17 | -- 60 FPS rendering with low CPU usage | |
| 18 | +- Up to 60 FPS rendering with low CPU usage | |
| 18 | 19 | - Robust time computations: float math is mostly avoided |
| 19 | 20 | |
| 20 | -## Install | |
| 21 | - | |
| 22 | -Flitter has been tested on Linux, but in theory it should work on MacOS as well. Windows is not supported. | |
| 23 | - | |
| 24 | -### OCaml Dependencies | |
| 25 | - | |
| 26 | -Flitter is mostly written in OCaml. | |
| 27 | - | |
| 28 | -Install opam: [opam install instructions](https://opam.ocaml.org/doc/Install.html) | |
| 29 | - | |
| 30 | -Set up opam and install OCaml dependencies: | |
| 31 | - | |
| 32 | -```bash | |
| 33 | -$ opam init | |
| 34 | -$ opam switch create 4.07.0 | |
| 35 | -$ opam install dune core lwt re color sexp_pretty uutf lwt_ppx uuseg notty | |
| 36 | -``` | |
| 37 | - | |
| 38 | -### Python Dependencies | |
| 39 | - | |
| 40 | -Flitter uses a tiny amount of Python to provide global hotkeys. | |
| 21 | +### Flitterite-specific features | |
| 41 | 22 | |
| 42 | -Install pip for Python 3. For example, on Ubuntu / Debian: | |
| 23 | +- Splits and history are now stored in a SQLite database of splits | |
| 24 | +- Import script for migrating from S-expressions to SQLite | |
| 25 | +- Statistics for splits | |
| 26 | +- Multiple routes and categories per game | |
| 27 | +- Nix flake | |
| 28 | +- Many bug fixes | |
| 43 | 29 | |
| 44 | -```bash | |
| 45 | -$ sudo apt install python3-pip | |
| 46 | -``` | |
| 30 | +## Install | |
| 47 | 31 | |
| 48 | -Install Python package dependencies: | |
| 32 | +Add this git repository to your Nix flake. | |
| 49 | 33 | |
| 50 | -```bash | |
| 51 | -$ pip3 install --user pynput | |
| 52 | -``` | |
| 34 | +## Usage | |
| 53 | 35 | |
| 54 | -### Install Flitter | |
| 36 | +Create your database of splits: | |
| 55 | 37 | |
| 56 | 38 | ```bash |
| 57 | -$ git clone --recursive https://github.com/alexozer/flitter.git | |
| 58 | -$ cd flitter | |
| 59 | -$ dune build | |
| 60 | -$ dune install | |
| 39 | +$ flitter-new splits.db | |
| 61 | 40 | ``` |
| 62 | 41 | |
| 63 | -## Usage | |
| 64 | - | |
| 65 | -Create your splits: | |
| 66 | - | |
| 67 | -Copy `examples/splits.scm` somewhere. Edit it and add your game and split information. The personal best splits, world record splits, and gold segments are not required. | |
| 68 | - | |
| 69 | 42 | Launch Flitter with your splits file: |
| 70 | 43 | |
| 71 | 44 | ```bash |
| 72 | -$ flitter my-splits.scm | |
| 45 | +$ flitter splits.db | |
| 73 | 46 | ``` |
| 74 | 47 | |
| 75 | -**Warning:** Don't edit your splits file while Flitter is running, your changes will be overwritten. | |
| 76 | - | |
| 77 | 48 | ### Keybindings |
| 78 | 49 | |
| 79 | 50 | Keybindings are all global hotkeys; they will work even when the terminal is not focused. |
| @@ -90,4 +61,5 @@ Keybindings are all global hotkeys; they will work even when the terminal is not | ||
| 90 | 61 | |
| 91 | 62 | ## Contributing |
| 92 | 63 | |
| 93 | -Feel free to make an issue or a pull request! | |
| 64 | +Feel free to make an issue or a pull request! Also feel free to copy any | |
| 65 | +changes back to Flitter. |
Fork
LICENSE