Compare commits

..
Author SHA1 Message Date
EIREXE eb59eb5b67 Extract fixedmat4 into its own separate module.
CI / build-and-test (pull_request) Successful in 1m9s
2026-09-17 16:01:11 +02:00
EIREXE fc37afc5a0 Split baked animation modules
CI / build-and-test (pull_request) Successful in 1m17s
2026-09-17 12:21:19 +02:00
6 changed files with 42 additions and 321 deletions
+10 -13
View File
@@ -1,15 +1,12 @@
# Shinespark # Game Test
Fancy heavily advanced platform fighting game A Bevy game, editable in the [jackdaw](https://github.com/jbuehler23/jackdaw) editor.
## Direct P2P Debugging - `cargo run` plays the game standalone; no editor required.
- Open the folder in jackdaw to author scenes, then hit Play. The
```text editor builds its own artifacts into `.jackdaw/` (gitignored) and
# Process 1 owns player 0 and listens on 7000. never modifies your manifest or lockfile.
cargo run -- --debug-match --players 2 --local-port 7000 \ - Gameplay lives in `src/lib.rs` (`GamePlugin`); authored scenes live
--net-player 0=local --net-player 1=127.0.0.1:7001 in `assets/*.bsn`.
- Components you derive `Reflect` on appear in the editor's inspector
# Process 2 owns player 1 and listens on 7001. automatically; no registration code is needed.
cargo run -- --debug-match --players 2 --local-port 7001 \
--net-player 0=127.0.0.1:7000 --net-player 1=local
```
-8
View File
@@ -1,8 +0,0 @@
#!/bin/bash
FIRST="cargo run -- --debug-match --players 2 --local-port 7000 \
--net-player 0=local --net-player 1=127.0.0.1:7001"
SECOND="cargo run -- --debug-match --players 2 --local-port 7001 \
--net-player 0=127.0.0.1:7000 --net-player 1=local"
(trap 'kill 0' SIGINT; $FIRST & $SECOND)
-45
View File
@@ -1,6 +1,5 @@
use bevy::prelude::*; use bevy::prelude::*;
use clap::Parser; use clap::Parser;
use std::net::SocketAddr;
use std::path::PathBuf; use std::path::PathBuf;
#[derive(Parser, Debug, Clone, Resource)] #[derive(Parser, Debug, Clone, Resource)]
@@ -16,12 +15,6 @@ pub struct Args {
pub check_distance: usize, pub check_distance: usize,
#[clap(long, default_value_t = 1)] #[clap(long, default_value_t = 1)]
pub players: usize, pub players: usize,
/// UDP port to bind for a direct peer-to-peer session.
#[clap(long, default_value_t = 6969)]
pub local_port: u16,
/// Player ownership declarations in the form HANDLE=local or HANDLE=ADDRESS.
#[clap(long = "net-player", value_name = "HANDLE=local|ADDRESS")]
pub net_players: Vec<String>,
/// Record a replay to this path. /// Record a replay to this path.
#[clap(long, conflicts_with = "play_replay")] #[clap(long, conflicts_with = "play_replay")]
pub record_replay: Option<PathBuf>, pub record_replay: Option<PathBuf>,
@@ -32,41 +25,3 @@ pub struct Args {
#[clap(long, value_enum, default_value_t = crate::replay::ReplayFormat::Binary)] #[clap(long, value_enum, default_value_t = crate::replay::ReplayFormat::Binary)]
pub replay_format: crate::replay::ReplayFormat, pub replay_format: crate::replay::ReplayFormat,
} }
pub fn parse_socket_addr(value: &str) -> Result<SocketAddr, String> {
let address = value
.parse::<SocketAddr>()
.map_err(|_| format!("invalid socket address: {value}"))?;
if address.port() == 0 {
return Err(format!("socket address must use a nonzero port: {value}"));
}
Ok(address)
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn parses_network_options() {
let args = Args::try_parse_from([
"game",
"--local-port",
"7000",
"--net-player",
"0=local",
"--net-player",
"1=127.0.0.1:7001",
])
.unwrap();
assert_eq!(args.local_port, 7000);
assert_eq!(args.net_players, ["0=local", "1=127.0.0.1:7001"]);
}
#[test]
fn rejects_invalid_socket_addresses() {
assert!(parse_socket_addr("127.0.0.1:0").is_err());
assert!(parse_socket_addr("not-an-address").is_err());
}
}
-1
View File
@@ -71,7 +71,6 @@ pub enum AppState {
LoadingMatch, LoadingMatch,
PreparingMatch, PreparingMatch,
InMatch, InMatch,
MatchDisconnected,
MatchLoadFailed, MatchLoadFailed,
} }
+7 -44
View File
@@ -8,28 +8,25 @@ use bevy_ggrs::prelude::Session;
use serde::{Deserialize, Serialize}; use serde::{Deserialize, Serialize};
use crate::{ use crate::{
AppState,
args::Args, args::Args,
fighter::{ fighter::{
FighterId, FighterRoster,
animation::AnimKind, animation::AnimKind,
attack::{AttackKind, FighterAttackScriptAssets}, attack::{AttackKind, FighterAttackScriptAssets},
baked_animation::{BakedFighterAnimations, BAKED_ANIMATION_FPS}, baked_animation::{BAKED_ANIMATION_FPS, BakedFighterAnimations},
manifest::{FighterManifest, FighterManifestRegistry}, manifest::{FighterManifest, FighterManifestRegistry},
spawn_fighter, spawn_fighter,
visual::FighterAnimations, visual::FighterAnimations,
FighterId, FighterRoster,
}, },
input::{LocalInputAssignments, LocalInputSource}, input::{LocalInputAssignments, LocalInputSource},
math::{int::FGi32, vec::FGVec2}, math::{int::FGi32, vec::FGVec2},
netcode::{ netcode::{GGRSCfg, session::create_session},
session::{create_session, ConnectionStatus, SessionConfig},
GGRSCfg,
},
scripting::FighterAttackScript, scripting::FighterAttackScript,
stage::{ stage::{
self, self,
manifest::{StageId, StageManifest, StageManifestRegistry}, manifest::{StageId, StageManifest, StageManifestRegistry},
}, },
AppState,
}; };
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)] #[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
@@ -143,7 +140,6 @@ pub fn initiate_match(
next_state: &mut NextState<AppState>, next_state: &mut NextState<AppState>,
request: PendingMatch, request: PendingMatch,
) { ) {
commands.remove_resource::<crate::netcode::session::MatchDisconnected>();
commands.insert_resource(request); commands.insert_resource(request);
next_state.set(AppState::LoadingMatch); next_state.set(AppState::LoadingMatch);
} }
@@ -180,14 +176,6 @@ pub fn initiate_default_match(
} }
return; return;
} }
let session_config = match SessionConfig::from_args(&args, args.players) {
Ok(config) => config,
Err(error) => {
error!("Invalid network configuration: {error}");
next_state.set(AppState::MatchLoadFailed);
return;
}
};
let players = (0..args.players) let players = (0..args.players)
.map(|handle| MatchPlayer { .map(|handle| MatchPlayer {
handle, handle,
@@ -195,21 +183,10 @@ pub fn initiate_default_match(
}) })
.collect(); .collect();
assigments.clear(); assigments.push((0, LocalInputSource::Keyboard));
let local_handles = session_config
.players
.iter()
.enumerate()
.filter_map(|(handle, player)| {
matches!(player, crate::netcode::session::PlayerConnection::Local).then_some(handle)
});
let mut local_handles = local_handles;
if let Some(handle) = local_handles.next() {
assigments.push((handle, LocalInputSource::Keyboard));
}
for (entity, handle) in gamepads.iter().zip(local_handles) { for (idx, entity) in gamepads.iter().take(args.players - 1).enumerate() {
assigments.push((handle, LocalInputSource::Gamepad(entity))); assigments.push((idx + 1, LocalInputSource::Gamepad(entity)));
} }
initiate_match( initiate_match(
@@ -396,16 +373,6 @@ pub fn prepare_match(
)); ));
} }
let session_config = match SessionConfig::from_args(&args, request.players.len()) {
Ok(config) => config,
Err(error) => {
fail_match(
&mut next_state,
&format!("invalid network configuration: {error}"),
);
return;
}
};
let session = match create_session(&args, request.players.len()) { let session = match create_session(&args, request.players.len()) {
Ok(session) => session, Ok(session) => session,
Err(error) => { Err(error) => {
@@ -451,8 +418,6 @@ pub fn prepare_match(
} }
commands.insert_resource(FighterRoster(fighter_roster)); commands.insert_resource(FighterRoster(fighter_roster));
commands.insert_resource(session_config);
commands.insert_resource(ConnectionStatus::default());
commands.insert_resource::<Session<GGRSCfg>>(session); commands.insert_resource::<Session<GGRSCfg>>(session);
next_state.set(AppState::InMatch); next_state.set(AppState::InMatch);
} }
@@ -483,8 +448,6 @@ pub fn cleanup_match(
commands.entity(fighter).despawn(); commands.entity(fighter).despawn();
} }
commands.remove_resource::<Session<GGRSCfg>>(); commands.remove_resource::<Session<GGRSCfg>>();
commands.remove_resource::<SessionConfig>();
commands.remove_resource::<ConnectionStatus>();
commands.remove_resource::<stage::line::StageCollision>(); commands.remove_resource::<stage::line::StageCollision>();
commands.remove_resource::<MatchAssets>(); commands.remove_resource::<MatchAssets>();
commands.remove_resource::<PendingMatch>(); commands.remove_resource::<PendingMatch>();
+21 -206
View File
@@ -1,234 +1,49 @@
//! Bringing up GGRS sessions and reporting their connection lifecycle. //! Bringing up the GGRS session and reporting what it does.
use std::net::SocketAddr;
use bevy::prelude::*; use bevy::prelude::*;
use bevy_ggrs::{ggrs::UdpNonBlockingSocket, prelude::*}; use bevy_ggrs::{ggrs::UdpNonBlockingSocket, prelude::*};
use thiserror::Error;
use crate::args::{parse_socket_addr, Args}; use crate::args::Args;
use crate::netcode::GGRSCfg; use crate::netcode::GGRSCfg;
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum PlayerConnection {
Local,
Remote(SocketAddr),
}
#[derive(Clone, Debug, PartialEq, Eq, Resource)]
pub struct SessionConfig {
pub local_port: u16,
pub players: Vec<PlayerConnection>,
}
#[derive(Debug, Error, PartialEq, Eq)]
pub enum SessionConfigError {
#[error("a session must have at least one player")]
NoPlayers,
#[error("local UDP port must be nonzero")]
LocalPortZero,
#[error("invalid network player declaration `{0}`; expected HANDLE=local or HANDLE=ADDRESS")]
InvalidPlayerDeclaration(String),
#[error("network player handle {0} is outside the session player range")]
PlayerHandleOutOfRange(usize),
#[error("network player handle {0} was declared more than once")]
DuplicatePlayerHandle(usize),
#[error("network player {0} has an invalid address: {1}")]
InvalidRemoteAddress(usize, String),
#[error("at least one player must be local")]
NoLocalPlayers,
#[error("network player declarations are not supported in sync-test or replay mode")]
UnsupportedOfflineNetworkConfig,
}
impl SessionConfig {
pub fn from_args(args: &Args, player_count: usize) -> Result<Self, SessionConfigError> {
if player_count == 0 {
return Err(SessionConfigError::NoPlayers);
}
if args.local_port == 0 {
return Err(SessionConfigError::LocalPortZero);
}
if (args.synctest || args.play_replay.is_some()) && !args.net_players.is_empty() {
return Err(SessionConfigError::UnsupportedOfflineNetworkConfig);
}
let mut players = vec![PlayerConnection::Local; player_count];
for declaration in &args.net_players {
let Some((handle, address)) = declaration.split_once('=') else {
return Err(SessionConfigError::InvalidPlayerDeclaration(
declaration.clone(),
));
};
let handle = handle
.parse::<usize>()
.map_err(|_| SessionConfigError::InvalidPlayerDeclaration(declaration.clone()))?;
if handle >= player_count {
return Err(SessionConfigError::PlayerHandleOutOfRange(handle));
}
if !matches!(players[handle], PlayerConnection::Local)
|| args.net_players[..]
.iter()
.take_while(|item| *item != declaration)
.any(|item| {
item.split_once('=')
.and_then(|(handle, _)| handle.parse::<usize>().ok())
== Some(handle)
})
{
return Err(SessionConfigError::DuplicatePlayerHandle(handle));
}
players[handle] = if address == "local" {
PlayerConnection::Local
} else {
PlayerConnection::Remote(
parse_socket_addr(address)
.map_err(|error| SessionConfigError::InvalidRemoteAddress(handle, error))?,
)
};
}
if !players
.iter()
.any(|player| matches!(player, PlayerConnection::Local))
{
return Err(SessionConfigError::NoLocalPlayers);
}
Ok(Self {
local_port: args.local_port,
players,
})
}
}
pub fn create_session(args: &Args, player_count: usize) -> Result<Session<GGRSCfg>> { pub fn create_session(args: &Args, player_count: usize) -> Result<Session<GGRSCfg>> {
let config = SessionConfig::from_args(args, player_count)
.map_err(|error| bevy::ecs::error::BevyError::from(error.to_string()))?;
let mut sess_build = SessionBuilder::<GGRSCfg>::new() let mut sess_build = SessionBuilder::<GGRSCfg>::new()
.with_num_players(player_count)? .with_num_players(player_count)?
.with_check_distance(args.check_distance) .with_check_distance(args.check_distance)
.with_input_delay(args.input_delay); .with_input_delay(args.input_delay); // (optional) set input delay for the local player
for (handle, player) in config.players.iter().enumerate() { for i in 0..player_count {
let player_type = match player { sess_build = sess_build.add_player(PlayerType::Local, i)?;
PlayerConnection::Local => PlayerType::Local,
PlayerConnection::Remote(address) => PlayerType::Remote(*address),
};
sess_build = sess_build.add_player(player_type, handle)?;
} }
if args.synctest { if args.synctest {
info!("starting GGRS sync test"); println!("Start synctest!");
Ok(Session::SyncTest(sess_build.start_synctest_session()?)) let sess = sess_build.start_synctest_session()?;
Ok(Session::SyncTest(sess))
} else { } else {
info!( println!("Start p2p!");
"starting direct UDP P2P session on port {}", let socket = UdpNonBlockingSocket::bind_to_port(6969)?;
config.local_port let sess = sess_build.start_p2p_session(socket)?;
); Ok(Session::P2P(sess))
let socket = UdpNonBlockingSocket::bind_to_port(config.local_port)?;
Ok(Session::P2P(sess_build.start_p2p_session(socket)?))
} }
} }
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Resource)] pub fn print_events_system(session: Option<ResMut<Session<GGRSCfg>>>) {
pub enum ConnectionStatus { let Some(mut session) = session else {
#[default]
Connecting,
Running,
Interrupted,
}
#[derive(Debug, Clone, PartialEq, Eq, Resource)]
pub struct MatchDisconnected {
pub address: SocketAddr,
}
pub fn print_events_system(
mut commands: Commands,
mut next_state: ResMut<NextState<crate::AppState>>,
mut status: Option<ResMut<ConnectionStatus>>,
session: Option<ResMut<Session<GGRSCfg>>>,
) {
let (Some(mut session), Some(status)) = (session, status.as_deref_mut()) else {
return; return;
}; };
let Session::P2P(session) = session.as_mut() else { match session.as_mut() {
return; Session::P2P(s) => {
}; for event in s.events() {
for event in session.events() {
match event { match event {
GgrsEvent::NetworkInterrupted { addr, .. } => { GgrsEvent::Disconnected { .. } | GgrsEvent::NetworkInterrupted { .. } => {
warn!("GGRS network interrupted: {addr}"); warn!("GGRS event: {event:?}")
*status = ConnectionStatus::Interrupted;
} }
GgrsEvent::NetworkResumed { addr } => { GgrsEvent::DesyncDetected { .. } => error!("GGRS event: {event:?}"),
info!("GGRS network resumed: {addr}");
*status = ConnectionStatus::Running;
}
GgrsEvent::Disconnected { addr } => {
error!("GGRS peer disconnected: {addr}");
commands.insert_resource(MatchDisconnected { address: addr });
next_state.set(crate::AppState::MatchDisconnected);
}
GgrsEvent::Synchronized { .. } => {
info!("GGRS session synchronized");
*status = ConnectionStatus::Running;
}
GgrsEvent::DesyncDetected { .. } => error!("GGRS desync detected: {event:?}"),
_ => info!("GGRS event: {event:?}"), _ => info!("GGRS event: {event:?}"),
} }
} }
}
#[cfg(test)]
mod tests {
use super::*;
use clap::Parser;
fn args(values: &[&str]) -> Args {
Args::try_parse_from(values).unwrap()
} }
_ => {}
#[test]
fn defaults_to_local_players() {
let config = SessionConfig::from_args(&args(&["game", "--players", "2"]), 2).unwrap();
assert_eq!(
config.players,
[PlayerConnection::Local, PlayerConnection::Local]
);
}
#[test]
fn configures_remote_players_by_handle() {
let config = SessionConfig::from_args(
&args(&["game", "--players", "2", "--net-player", "1=127.0.0.1:7001"]),
2,
)
.unwrap();
assert!(matches!(config.players[0], PlayerConnection::Local));
assert!(matches!(config.players[1], PlayerConnection::Remote(_)));
}
#[test]
fn validates_handles_and_local_ownership() {
let duplicate = args(&[
"game",
"--players",
"2",
"--net-player",
"1=127.0.0.1:7001",
"--net-player",
"1=127.0.0.1:7002",
]);
assert!(matches!(
SessionConfig::from_args(&duplicate, 2),
Err(SessionConfigError::DuplicatePlayerHandle(1))
));
let no_local = args(&["game", "--players", "1", "--net-player", "0=127.0.0.1:7001"]);
assert!(matches!(
SessionConfig::from_args(&no_local, 1),
Err(SessionConfigError::NoLocalPlayers)
));
} }
} }