diff options
| author | bigbass1997 <bigbass1997.website@gmail.com> | 2025-04-16 16:01:58 -0500 |
|---|---|---|
| committer | bigbass1997 <bigbass1997.website@gmail.com> | 2025-04-16 16:01:58 -0500 |
| commit | 892d176092c73191f75bfedd24dd2e95f3fa69ee (patch) | |
| tree | f52341961455bcaa582def8edaceb12a966e3e5e | |
| parent | c9539f1127e3fe50a07c87a9420df3bcc3380cea (diff) | |
| download | tasd-892d176092c73191f75bfedd24dd2e95f3fa69ee.tar.gz tasd-892d176092c73191f75bfedd24dd2e95f3fa69ee.zip | |
Early preparations before releasing version 1.
| -rw-r--r-- | CONTRIBUTING.md | 1 | ||||
| -rw-r--r-- | README.md | 6 |
2 files changed, 3 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3a757a8..92a5978 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,6 @@ If you wish to contribute to this project, please be aware of and follow these rules. * If you make an update to this repository, please update the `CHANGELOG.md` file accordingly. The style of the `CHANGELOG.md` file is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), although currently without version numbers added. -* If you update the `CHANGELOG.md` file, please try to only make one date worth of updates, for when you are ready to push the update, rather than writing update entries every day you add new features before making a pull request * If you edit the `.xml` file in `src/docs/`, please update the changelog at the bottom of the `.xml` file. The current style is `draft [{DraftNum}] - {Year}-{Month}-{Day} {Initials} {Description}` followed by a new line, where {DraftNum} is an incrementing 2 digit decimal number (can be 00-99), {Year} is the 4 digit year number, {Month} is the 2 digit month number, {Day} is the 2 digit day number, {Initials} are some initials to help differentiate changelog editors (Vi Grey's initials are **VG**, for example), and {Description} is a description of what you changed. * If you edit the ``.xml` file in `src/docs/`, use `make clean; make; make contribution` at the root directory of this repository to create the new document files and automatically add them to `docs/latest/` and `docs/tasd-spec-{version}/`. * Please (for the moment at least) try to keep individual updates relatively single-subject in nature. For instance, if you're working on fixing a bunch of typos, try to make the update essentially only about fixing typos. @@ -6,11 +6,11 @@ Specification and Tools for the Tool Assisted Speedrun Dump (TASD) interchange f ## Description: -The Tool Assisted Speedrun Dump (TASD) interchange format is a file format initially designed by [Vi Grey](https://github.com/vigrey) and [Bigbass](https://github.com/bigbass1997) for storing data to allow "Tool Assisted Speedruns" or "Tool Assited Superplays" to be played on physical video game console hardware using TAS replay devices. Created to be hardware and software agnostic, the TASD interchange format uses a key-based, binary, packet format to break up pieces of information into easily-parsable and forward-compatible chunks. The format is extensible by simply defining additional keys or value types as necessary. When parsing the file, software can skip any packets whose key is unknown or unsupported. +The Tool Assisted Speedrun Dump (TASD) interchange format is a file format initially designed by [Vi Grey](https://vigrey.com) and [Bigbass](https://github.com/bigbass1997) for storing "Tool Assisted Speedrun" or "Tool Assisted Superplay" (TAS) input and configuration data for use with devices (known as "TAS replay devices") that replay inputs on physical video game hardware. Created to be hardware and software agnostic, the TASD interchange format uses a key-based, binary, packet format to break up pieces of information into easily-parsable and forward-compatible chunks. The format is extensible by simply defining additional keys or value types as necessary. When parsing the file, software can skip any packets whose key is unknown or unsupported. -Keys can be used multiple times or completely omitted as needed. This reusability eliminates the need of a predefined delimiter to separate pieces of data such as a list of TAS authors. +Packets of a given type can be used multiple times or completely omitted as needed. This reusability eliminates the need of a predefined delimiter to separate pieces of data, such as a list of TAS authors. -While files generated by emulator dump scripts should provide as much information as possible, because keys are optional, the file can be expanded later with any additional data as desired. No intermediary file format is necessary. +While files generated by emulator dump scripts should provide as much information as possible, they may be unable to provide everything. Since packets are optional, the file can be expanded later with any additional data as desired. No intermediary file format is necessary. ## **Reading the Specification Documentation** |
