termfront 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 97daf7d1b118259e9d1bf5913b4f24ea301c5b3bea048c5b45b37f3df164a61c
+  data.tar.gz: 0d4911cd9755884f61dc9d8ee5400655d654dd55e710784997c974414626d5ce
+SHA512:
+  metadata.gz: 7a19c3fa19333be6ddb23f63d2d944e70ea2f5128a0461822283ac3853046a82179aed19cdd5c8e46d36750afd1fddea6eb12f50c9be4d055077f3fe6f7d892d
+  data.tar.gz: ad42e1e6b604b473c5124b526e9510e0c33cfc01fdf44609822ec12784f4a7b24165d2dcaa95e488393163a7a80d84478f40293fc0b8689951be5eb99a267fb7

data/CHANGELOG.md

@@ -0,0 +1,41 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on Keep a Changelog, and this project follows Semantic Versioning as it stabilizes.
+
+## [0.1.0] - 2026-05-20
+
+Initial public gem release candidate.
+
+### Added
+
+- Terminal FPS core with DDA raycasting renderer
+- Singleplayer mission mode
+- Campaign mode with multiple missions
+- JSON-driven campaign event system
+- Story scenes with dialogue and title cards
+- In-mission terminal interactions tied to campaign events
+- Experimental PvP mode over TCP + TLS
+- PvP matchmaking queues for `1v1`, `2v2`, and `4v4`
+- Wavesfight PvE mode with stage selection, wave-based survival, and optional 2-player co-op
+- External audio manifest and runtime audio playback
+- Third-party audio notices for bundled CC0 assets
+- Looping shield regeneration audio channel separate from BGM
+
+### Changed
+
+- Improved title/campaign transitions by fixing incomplete terminal writes
+- Added terminal markers to the radar and interaction HUD
+- Reworked campaign story content and terminal logs
+- Replaced placeholder audio mappings with selected CC0 assets for BGM and core SE
+- Reworked PvP client/server flow for team-based matches with ally/enemy sync, elimination handling, and team win detection
+- Updated PvP spawn placement to use walkable map positions and improved diagonal team separation
+- Updated PvP match-size selection to support arrow keys in addition to `J`/`K`
+- Disabled quitting PvP matches with `Q` to avoid accidental exits during combat
+- Added Wavesfight arena registration for `Corridor Sweep`, `Stronghold`, and `Final Push`
+
+### Notes
+
+- PvP is still considered experimental and needs broader WAN verification
+- Audio playback depends on an available local player such as `ffplay`, `afplay`, `paplay`, or `aplay`

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 S.H.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 S-H-GAMELINKS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,160 @@
+# Termfront
+
+`Termfront` is a terminal FPS built in Ruby with a raycasting renderer, campaign scripting, audio support, and experimental PvP multiplayer.
+
+## Features
+
+- DDA raycasting renderer for ANSI terminals
+- Singleplayer mission mode
+- Wavesfight PvE mode with wave-based survival arenas
+- Campaign mode with intro/outro scenes and in-mission terminals
+- Experimental PvP over TCP + TLS
+- Radar, pickups, weapons, shields, and enemy projectiles
+- External audio manifest with BGM, SE, and looped shield regeneration audio
+
+## Requirements
+
+- Ruby `>= 3.2`
+- A terminal with ANSI escape sequence support
+- One of these audio players if you want sound:
+  - `ffplay`
+  - `afplay`
+  - `paplay`
+  - `aplay`
+
+RubyGems metadata currently targets Ruby `0.1.0`.
+
+## Installation
+
+If the gem is published:
+
+```bash
+gem install termfront
+```
+
+For local development from this repository:
+
+```bash
+bundle install
+bundle exec rake test
+bundle exec rake install
+```
+
+## Running
+
+Start the game:
+
+```bash
+termfront
+```
+
+Start a PvP server:
+
+```bash
+termfront-server
+```
+
+Use a custom port:
+
+```bash
+termfront-server 9000
+```
+
+Default PvP port is `7777`.
+
+## Controls
+
+- `W` `A` `S` `D`: move
+- `Left` / `Right`: turn
+- `Space`: fire
+- `T`: swap weapon
+- `E`: interact / pick up / use terminal
+- `Q` or `Esc`: quit or back out
+- `Enter`: confirm menus
+
+In story scenes:
+
+- `Enter` / `Space`: next page
+- `Esc` / `Q`: skip scene
+
+## Modes
+
+### Singleplayer
+
+Quick mission start for testing the core combat loop.
+
+### Campaign
+
+Campaign missions include:
+
+- mission start scenes
+- mission complete scenes
+- optional in-mission terminal logs
+
+Story/event data lives in `data/events/*.json`.
+
+### Wavesfight
+
+Wavesfight is a PvE survival mode built on selected campaign maps.
+
+- Select from `Corridor Sweep`, `Stronghold`, and `Final Push`
+- Survive escalating enemy waves
+- Difficulty ramps up every few waves
+- Shield, health, and ammo get a partial refresh between waves
+- Supports both solo play and 2-player online co-op
+
+### PvP
+
+PvP is currently marked experimental.
+
+- The server listens on TCP and wraps traffic with TLS.
+- The client connects directly to `host:port`.
+- Matchmaking now supports `1v1`, `2v2`, and `4v4`.
+- Players choose the match size on the client, and the server keeps separate queues for each mode.
+- Team matches end when one side is fully eliminated.
+- Local relay/start/state/ping behavior is covered by tests.
+- Internet/WAN play still needs broader real-world verification.
+
+For internet testing, the simplest setups are:
+
+- direct TCP port forwarding to the host running `termfront-server`
+- `nginx stream` TCP passthrough on a VPS
+- a mesh/VPN overlay such as Tailscale
+
+## Audio
+
+Audio mappings are defined in:
+
+- [data/audio/manifest.json](data/audio/manifest.json)
+
+Third-party audio notices are tracked here:
+
+- [data/audio/THIRD_PARTY_NOTICES.md](data/audio/THIRD_PARTY_NOTICES.md)
+
+If no supported audio player is available, the game still runs without sound.
+
+## Development
+
+Run tests:
+
+```bash
+ruby -Itest test/test_termfront.rb
+```
+
+Build the gem:
+
+```bash
+gem build termfront.gemspec
+```
+
+Install the built gem locally:
+
+```bash
+gem install ./termfront-0.1.0.gem
+```
+
+## License
+
+Code is available under the [MIT License](LICENSE.txt).
+
+Third-party audio assets remain under their own licenses as documented in [data/audio/THIRD_PARTY_NOTICES.md](data/audio/THIRD_PARTY_NOTICES.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/data/audio/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,45 @@
+# Third-Party Audio Notices
+
+## In Use
+
+### Dark Sci-Fi Audio Pack
+
+- Author: SRG774
+- License: CC0 1.0 Universal
+- Source: https://opengameart.org/content/dark-sci-fi-audio-pack
+- Used files:
+  - `title.mp3` -> `title_bgm`
+  - `sector.mp3` -> `mission_bgm`
+  - `victory.mp3` -> `shield_regen` loop
+
+### 50 CC0 Sci-Fi SFX
+
+- Author: rubberduck
+- License: CC0 1.0 Universal
+- Source: https://opengameart.org/content/50-cc0-sci-fi-sfx
+- Used files:
+  - `shoot_01.ogg` -> `shoot`
+  - `beep_02.ogg` -> `shield_alarm`
+
+### 60 CC0 Sci-Fi SFX
+
+- Author: rubberduck
+- License: CC0 1.0 Universal
+- Source: https://opengameart.org/content/60-cc0-sci-fi-sfx
+- Used files:
+  - `sfx_22b.ogg` -> `damage`
+
+### UI Sounds
+
+- Author: StumpyStrust
+- License: CC0 1.0 Universal
+- Source: https://opengameart.org/content/ui-sounds
+- Used files:
+  - `button1.ogg` -> `terminal`
+  - `on.ogg` -> `page`
+  - `complete.ogg` -> `mission_clear`
+
+## Notes
+
+- Because these assets are CC0, they can be redistributed with the gem without changing the gem's own code license.
+- Even though attribution is not required for CC0 assets, this file keeps provenance clear for future maintenance.

data/data/audio/manifest.json

@@ -0,0 +1,17 @@
+{
+  "bgm": {
+    "title": "data/audio/title.mp3",
+    "mission": "data/audio/sector.mp3"
+  },
+  "se": {
+    "shoot": "data/audio/shoot_01.ogg",
+    "damage": "data/audio/sfx_22b.ogg",
+    "terminal": "data/audio/button1.ogg",
+    "mission_clear": "data/audio/complete.ogg",
+    "page": "data/audio/on.ogg",
+    "shield_alarm": "data/audio/beep_02.ogg"
+  },
+  "loop_se": {
+    "shield_regen": "data/audio/victory.mp3"
+  }
+}

data/data/events/corridor_sweep.json

@@ -0,0 +1,27 @@
+{
+  "events": [
+    {
+      "id": "corridor_sweep_intro",
+      "trigger": { "type": "mission_start" },
+      "actions": [
+        { "type": "dialogue", "speaker": "OPS", "text": "Facility A-13 went dark six hours ago. This corridor is your first live sector." },
+        { "type": "dialogue", "speaker": "OPS", "text": "Sweep the access corridor and recover any surviving logs before local systems collapse." }
+      ]
+    },
+    {
+      "id": "corridor_terminal_a",
+      "trigger": { "type": "terminal_used", "terminal_id": "ops_corridor_a" },
+      "actions": [
+        { "type": "text", "text": "OPS LOG 04\nPower loss started in the maintenance wing, then moved against cable direction.\nSecurity sealed Sector C after staff reported chanting inside locked rooms." }
+      ]
+    },
+    {
+      "id": "corridor_sweep_outro",
+      "trigger": { "type": "mission_complete" },
+      "actions": [
+        { "type": "dialogue", "speaker": "OPS", "text": "Corridor secure. The blackout did not stop the transmissions." },
+        { "type": "dialogue", "speaker": "OPS", "text": "Advance to the service run. If the logs are right, the facility was sealing something in, not keeping us out." }
+      ]
+    }
+  ]
+}

data/data/events/final_push.json

@@ -0,0 +1,40 @@
+{
+  "events": [
+    {
+      "id": "final_push_intro",
+      "trigger": { "type": "mission_start" },
+      "actions": [
+        { "type": "dialogue", "speaker": "OPS", "text": "This is the last gate. Expect fortress-grade resistance and no clean answers." },
+        { "type": "dialogue", "speaker": "OPS", "text": "If the archive core is intact, bring back whatever it stored and who authorized the breach." }
+      ]
+    },
+    {
+      "id": "final_push_terminal_archive",
+      "trigger": { "type": "terminal_used", "terminal_id": "archive_core" },
+      "actions": [
+        { "type": "text", "text": "ARCHIVE CORE\nDirective mismatch detected.\nContainment protocol revoked by archive authority: ORPHEUS.\nLocal command objections logged, denied, and sealed." }
+      ]
+    },
+    {
+      "id": "final_push_outro",
+      "trigger": { "type": "mission_complete" },
+      "actions": [
+        {
+          "type": "demo",
+          "duration": 3.0,
+          "caption": "ARCHIVE VAULT / SIGNAL STILL PRESENT",
+          "path": [
+            { "x": 20.5, "y": 9.5, "angle": 3.14, "t": 0.0 },
+            { "x": 16.5, "y": 9.5, "angle": 3.05, "t": 1.0 },
+            { "x": 11.5, "y": 9.5, "angle": 2.95, "t": 2.0 },
+            { "x": 7.5, "y": 8.5, "angle": 2.75, "t": 3.0 }
+          ]
+        },
+        { "type": "title_card", "text": "FORTRESS CLEARED\nSIGNAL SOURCE UNRESOLVED" },
+        { "type": "dialogue", "speaker": "OPS", "text": "Fortress cleared. The signal is still active somewhere below you." },
+        { "type": "dialogue", "speaker": "OPS", "text": "This facility did not fail containment. Someone revoked it." },
+        { "type": "dialogue", "speaker": "OPS", "text": "Archive authority ORPHEUS is still broadcasting. This sector is over, but the incident is not." }
+      ]
+    }
+  ]
+}

data/data/events/stronghold.json

@@ -0,0 +1,27 @@
+{
+  "events": [
+    {
+      "id": "stronghold_intro",
+      "trigger": { "type": "mission_start" },
+      "actions": [
+        { "type": "dialogue", "speaker": "OPS", "text": "Inner rooms are fortified. Executors are holding the choke points on purpose." },
+        { "type": "dialogue", "speaker": "OPS", "text": "Break the stronghold and find the source of their command signal before it reroutes again." }
+      ]
+    },
+    {
+      "id": "stronghold_terminal_guard",
+      "trigger": { "type": "terminal_used", "terminal_id": "guard_post" },
+      "actions": [
+        { "type": "text", "text": "SECURITY POST\nStaff rotation suspended by archive authority, not site command.\nAny report of ritual language is to be escalated and removed from local logs before outside review." }
+      ]
+    },
+    {
+      "id": "stronghold_outro",
+      "trigger": { "type": "mission_complete" },
+      "actions": [
+        { "type": "dialogue", "speaker": "OPS", "text": "Stronghold is down. Something in the facility wanted time, not victory." },
+        { "type": "dialogue", "speaker": "OPS", "text": "Archive authority overrode local containment. Push the final gate and confirm what they were trying to keep active." }
+      ]
+    }
+  ]
+}

data/data/events/the_gauntlet.json

@@ -0,0 +1,27 @@
+{
+  "events": [
+    {
+      "id": "the_gauntlet_intro",
+      "trigger": { "type": "mission_start" },
+      "actions": [
+        { "type": "dialogue", "speaker": "OPS", "text": "The service corridor ahead is a kill lane, but its layout is wrong for defense." },
+        { "type": "dialogue", "speaker": "OPS", "text": "Push through fast. If a terminal still answers, check why the shutters were chained inward." }
+      ]
+    },
+    {
+      "id": "the_gauntlet_terminal_service",
+      "trigger": { "type": "terminal_used", "terminal_id": "service_hub" },
+      "actions": [
+        { "type": "text", "text": "SERVICE HUB\nEmergency shutters failed in sequence from the archive end of the corridor.\nWitnesses reported synchronized movement before first contact, as if something was herding them away from the vault." }
+      ]
+    },
+    {
+      "id": "the_gauntlet_outro",
+      "trigger": { "type": "mission_complete" },
+      "actions": [
+        { "type": "dialogue", "speaker": "OPS", "text": "You made it through. The path deeper into the complex is open." },
+        { "type": "dialogue", "speaker": "OPS", "text": "These corridors were built to funnel breaches back toward the core. Move on the stronghold and find who broke the seal." }
+      ]
+    }
+  ]
+}

data/data/events/training_grounds.json

@@ -0,0 +1,31 @@
+{
+  "events": [
+    {
+      "id": "training_grounds_intro",
+      "trigger": { "type": "mission_start" },
+      "actions": [
+        { "type": "title_card", "text": "OPERATION: TRAINING GROUNDS\nSIMULATION WING / SECTOR A-13" },
+        { "type": "dialogue", "speaker": "OPS", "text": "This is a training sweep on paper. Treat it like deployment anyway." },
+        { "type": "dialogue", "speaker": "OPS", "text": "Sector A-13 lost contact beyond this wing. We are not waiting for a second failure." },
+        { "type": "dialogue", "speaker": "OPS", "text": "Use the yard terminals. They still carry the old incident briefings." }
+      ]
+    },
+    {
+      "id": "training_grounds_terminal_intro",
+      "trigger": { "type": "terminal_used", "terminal_id": "training_console" },
+      "actions": [
+        { "type": "text", "text": "TRAINING CONSOLE\nIncident drill package: Sector A-13 containment loss.\nScenario note: field teams are not to be told whether the exercise has gone live." }
+      ]
+    },
+    {
+      "id": "training_grounds_outro",
+      "trigger": { "type": "mission_complete" },
+      "actions": [
+        { "type": "title_card", "text": "SECTOR SECURE\nTRAINING SWEEP COMPLETE" },
+        { "type": "dialogue", "speaker": "OPS", "text": "Training sweep complete. Your live assignment starts now." },
+        { "type": "dialogue", "speaker": "OPS", "text": "The blackout in the next sector is real. This was the last clean room." },
+        { "type": "dialogue", "speaker": "OPS", "text": "Move to the access corridor. Recover logs before the sector goes completely dark." }
+      ]
+    }
+  ]
+}

data/exe/termfront

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "termfront"
+
+Termfront.start

data/exe/termfront-server

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "termfront"
+
+port = (ARGV[0] || Termfront::Config::PVP_PORT).to_i
+Termfront::Network::Server.new(port: port).run