Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
stephanebruckert authored Jun 7, 2024
1 parent ed23530 commit 0b31510
Showing 1 changed file with 22 additions and 22 deletions.
44 changes: 22 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -5,7 +5,6 @@ Worms W.M.D autosplitter for LiveSplit written in ASL (Auto-Splitter Language).
<!-- PROJECT SHIELDS -->
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
![Status](https://img.shields.io/badge/status-beta-blue)

## First Usage

@@ -14,35 +13,36 @@ This script is automatically detected by LiveSplit as part of https://github.com
The layout and splits files are somewhat personal and meant to be created from scratch, but can still be imported:
- .lss file (LiveSplit splits): keeps your own or someone else's splits times
- import from speedrun.com
- levels or run categories are not part of the script and need to be set in the LiveSplit splits. You can copy the missions from [here][missions-url].
- .lsl file (LiveSplit layout): your preferred layout
- import from a URL

## Installation

1. Open up LiveSplit
2. Go to `Edit Layout`
2. Go to the Splits Editor via `Edit Splits...`
3. Select Worms W.M.D as the game
4. You should now be able to select an autosplitter
4. Click Activate

## Requirements
## Timing methods (Training vs Campaign)

- To be displayed correctly, Game Time needs to be selected in the Splits and Timer components of the LiveSplit layout
- Levels or run categories are not part of the script and need to be set in the LiveSplit splits. You can copy the missions from [here][missions-url].
Categories are automatically detected and will set the timing method accordingly:

## Rules
- For training levels: Game Time only counts the in-game timers
- For campaign levels: Real Time removes level loading times

- Timers starts when first mission timer starts
- Missions can be played in any order
- Restarting is allowed, the previous attempt game time will be counted
- Restarting the first level resets all timers
- Split is done when the mission results appear
- Timer ends:
- Game Time ends when last mission timer ends
- Real Time ends when the last split happens
The splitter also works for single level runs, as long as only one level is set in the Splits Editor.

### TODO:
## Rules

- [x] Fix Bug: restarting a level sometimes substract a few seconds
- [ ] Fix minor UI Bug: the fix above makes the timer flash quickly with the wrong time
- Timers starts when first level timer starts
- Levels can be played in any order
- Restarting:
- any level is allowed, the previous attempt game time will be counted
- the first level resets all timers, as if a new run starts
- Split occurs when the mission results appear
- ⚠️ failing a campaign mission will automatically detect a split, which can be undone using the Undo Split hotkey (F3 by default)
- Timer ends when the last split happens

## Development

@@ -67,9 +67,9 @@ To view errors, use Event Viewer already on Windows.


<!-- VARIABLES -->
[issues-shield]: https://img.shields.io/github/issues/stephanebruckert/LiveSplit.WormsWMD.svg
[issues-url]: https://github.com/stephanebruckert/LiveSplit.WormsWMD/issues
[license-shield]: https://img.shields.io/github/license/stephanebruckert/LiveSplit.WormsWMD
[license-url]: https://github.com/stephanebruckert/LiveSplit.WormsWMD/blob/master/LICENSE
[issues-shield]: https://img.shields.io/github/issues/WormsSpeedrunning/LiveSplit.WormsWMD.svg
[issues-url]: https://github.com/WormsSpeedrunning/LiveSplit.WormsWMD/issues
[license-shield]: https://img.shields.io/github/license/WormsSpeedrunning/LiveSplit.WormsWMD
[license-url]: https://github.com/WormsSpeedrunning/LiveSplit.WormsWMD/blob/master/LICENSE
[missions-url]: https://docs.google.com/spreadsheets/d/1wLOU4FbLXlK7e3cd_i5Iwp5cv3UWQyyUSuk-VmZqfHk/edit

0 comments on commit 0b31510

Please sign in to comment.