Merge 7e848da into release

CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## Tiger 1.0.0
+
+- [x] ⚠ Tiger files saved with version 0.7.0 and older are no longer supported
+- [x] Tiger file format version was is now `1.0.0`
+- [x] Add up-to-date screenshots in readme
+- [x] Add video in readme
+- [x] Remove under-development warning from readme
+- [x] Logo in documentation
+- [x] Favicon in documentation
+- [x] Branding in installer
+- [x] App icon (file explorer, taskbar, add/remove programs)
+- [x] Github social media preview image
+- [x] Itch.io distribution
+- [x] Review all TODO
+
 ## Tiger 0.9.0
 
 - [x] Document keyboard shortcuts

MAINTENANCE.md

@@ -17,9 +17,10 @@
 
 # How to increment Tiger format version
 
-1. Create a new module file under `src/sheet/versionN.rs` (copy-paste the previous version as a starting point)
-2. In your new module, update the THIS_VERSION constant and the `as previous_version` import
+1. Create a new module file under `src/sheet/version_x_y_z_.rs` (copy-paste the previous version as a starting point)
+2. In your new module, update the `THIS_VERSION` constant and the `as previous_version` import
 3. Declare your new module in `src/sheet.rs`
 4. Also in `src/sheet.rs`, update the `Version` enum and the `CURRENT_VERSION` constant
 5. Update the `pub use self::versionN::*;` line in `src/sheet.rs`
-6. Update the sheet structures and From<> implementations in your new module as needed
+6. Update the sheet structures and `From<>` implementations in your new module as needed
+7. Add `#[allow(dead_code)]` to `key` fields causing warnings in the old version structs

README.md

@@ -2,35 +2,50 @@
 
 ![Tiger Logo](res/readme/logo.svg?raw=true "Tiger")
 
-Tiger is a graphical tool to author game spritesheets and their metadata.
+# Overview
+
+Tiger is a visual tool to author game spritesheets and their metadata.
+
+This tool bridges the gap between the work done by an artist and data needed by a game engine. Artists draw animations as images, but game engines need lots of metadata about how to use them correctly. Tiger gives you a simple interface to organize frames into animations like "run", "idle" or "attack". Tiger can also adjust offsets, timings, and hitboxes for each frame.
+
+After you organize everything in Tiger, it exports a spritesheet containing all the images, plus a metadata file. The exact format of this metadata file is defined by you, using a template system. This makes it easy to integrate Tiger sheets with any game engine.
 
 # Key Features
 
-- Author animations on an easy-to-use timeline
-- Top-down, sidescroller, isometric perspectives are supported (and more!)
-- Position and name hitboxes
-- Compress animation frames into compact texture atlases
-- Export metadata for any game engine, thanks to a template system
-- Source images hot-reload automatically when changed
-- Free and open-source with a permissive license
+- ✅ Easy-to-use timeline to author animations
+- ✅ Supports perspectives for any 2D game (top-down, sidescroller, isometric)
+- ✅ Source images hot-reload automatically when changed
+- ✅ Packs animation frames into texture atlases
+- ✅ Can add and tag hitboxes
+- ✅ Template system to export animation data in any text-based format
+- ✅ Free and open-source with a permissive license
+
+Note that Tiger is not:
+
+- ❌ A drawing program.
+- ❌ A skeletal animation program like Spine.
+- ❌ A plug-and-play solution for any specific engine. You will need code to use the output of Tiger in your engine of choice.
 
-⚠️ This project is under development.
+# Screenshots & Videos
+
+[tiger-demo-2.webm](https://user-images.githubusercontent.com/817256/223934634-59958844-6763-4e87-ad38-6aa69a6480d4.webm)
+
+|                                                                                                             |                                                                                                           |
+| :---------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------: |
+|          [![](res/readme/screenshot-1.0.0.png?raw=true)](res/readme/screenshot-1.0.0.png?raw=true)          |  [![](res/readme/screenshot-1.0.0-export.png?raw=true)](res/readme/screenshot-1.0.0-export.png?raw=true)  |
+| [![](res/readme/screenshot-1.0.0-relocate.png?raw=true)](res/readme/screenshot-1.0.0-relocate.png?raw=true) | [![](res/readme/screenshot-1.0.0-startup.png?raw=true)](res/readme/screenshot-1.0.0-startup.png?raw=true) |
 
 # Getting Started
 
-Tiger is only supported on Windows and has no dependencies. To install it:
+Tiger is only supported on Windows. To install it:
 
-1. Go to the [latest release](https://github.com/agersant/tiger/releases/latest) page
-2. Download the `.msi` installer
-3. Run the installer
+1. Go to the [latest release](https://github.com/agersant/tiger/releases/latest) page.
+2. Download the `.msi` installer.
+3. Run the installer. This will install Tiger and Microsoft Edge Webview (if necessary).
 4. That's it, you're done!
 
 To learn how to integrate Tiger sheets into your game, please refer to the [Documentation](https://agersant.github.io/tiger/).
 
-# Screenshots
-
-![Tiger](res/readme/screenshot-0.4.0.png?raw=true "Tiger")
-
 # Contributing
 
 - 🗨 For help, feedback or suggesting new features, please use [Discussions](https://github.com/agersant/tiger/discussions).

ROADMAP.md

@@ -1,20 +1,5 @@
 # Roadmap
 
-## Tiger 1.0
-
-- [ ] Review all TODO
-- [ ] Re-evaluate https://github.com/1Password/typeshare to auto-generate typescript DTOs
-- [ ] Tiger file format uses semver
-- [ ] Remove support for pre-1.0 versions of Tiger file format
-- [ ] Gif/video in readme
-- [ ] Remove under-development warning from readme
-- [ ] Logo in documentation
-- [ ] Favicon in documentation
-- [ ] Branding in installer and installer icon
-- [ ] App icon (file explorer, taskbar, add/remove programs, title bar)
-- [ ] Github social media preview image (in repo settings)
-- [ ] Itch.io or other distribution method
-
 ## Post 1.0
 
 - [ ] Tiger CLI
@@ -31,3 +16,4 @@
 - [ ] Drag and drop frames from OS to timeline panel
 - [ ] Project files (.tiger files within a project can be moved without breaking)
 - [ ] Cleanup application files and webview cache on uninstall (blocked by https://github.com/tauri-apps/tauri/issues/6103 or https://github.com/tauri-apps/tauri/issues/6113)
+- [ ] Re-evaluate https://github.com/1Password/typeshare to auto-generate typescript DTOs

docs/_config.yml

@@ -2,7 +2,8 @@ title: Tiger
 lang: en
 
 remote_theme: just-the-docs/just-the-docs
-color_scheme: dark
+color_scheme: tiger
+logo: "/media/logo.svg"
 
 plugins:
   - jemoji

docs/_sass/color_schemes/tiger.scss

@@ -0,0 +1,2 @@
+$link-color: $blue-000;
+$btn-primary-color: $blue-100;

docs/index.md

@@ -1,8 +1,9 @@
 ---
 nav_order: 1
+title: Home
 ---
 
-# Home
+# Tiger Documentation
 
 Welcome to the Tiger documentation!
 

docs/internals.md

@@ -13,9 +13,9 @@ nav_order: 2
   📁 my-documents
     📁 cool-game
       📄 hero.tiger
-	  📁 frames
-	  	🖼 hero-attack.png
-	  	🖼 hero-jump.png
+      📁 frames
+        🖼 hero-attack.png
+        🖼 hero-jump.png
 ```
 
 In this example, `hero.tiger` stores references to the `.png` files as `frames/hero-attack.png` and `frames/hero-jump.png` - omitting `C:\my-documents\cool-game`.