9 Commits
Author SHA1 Message Date
cneicy f573c8e742 feat: add NuGet and Godot distribution 2026-09-05 03:41:41 +08:00
cneicy 26241cb534 feat: add shared codegen support 2026-09-05 02:34:02 +08:00
cneicy dd13a01bc9 chore(editor): localize network menus
Publish UPM package / publish (push) Successful in 2s
2026-08-26 12:48:32 +08:00
cneicy da609cabb9 test(host): allow Unity test runner completion 2026-08-26 08:23:09 +08:00
cneicy 54cd4aab56 ci: mirror Git package dependencies 2026-08-26 07:07:04 +08:00
cneicy 6709e9dea3 test: enable standalone host discovery 2026-08-26 06:56:06 +08:00
cneicy e9ce97df85 ci: stabilize standalone Unity host 2026-08-26 06:36:36 +08:00
ShrinkSDK Automation e8407f1719 ci: fetch immutable release archive 2026-08-26 04:29:40 +08:00
ShrinkSDK Automation 0d0b237df7 ci: install Git in package publisher 2026-08-26 03:09:50 +08:00
15 changed files with 170 additions and 31 deletions
+52
View File
@@ -0,0 +1,52 @@
name: Publish NuGet packages
on:
push:
tags:
- 'v*'
workflow_dispatch:
jobs:
publish:
runs-on: ubuntu-latest
permissions:
contents: read
packages: write
env:
NUGET_AUTH_TOKEN: ${{ secrets.SHRINKSDK_PACKAGE_TOKEN }}
steps:
- name: Checkout tagged source
uses: actions/checkout@v4
- name: Set up .NET
uses: actions/setup-dotnet@v4
with:
dotnet-version: '8.0.x'
- name: Validate tag and pack projects
env:
GITEA_REF: ${{ gitea.ref }}
shell: bash
run: |
set -euo pipefail
tag="${GITEA_REF#refs/tags/}"
version="$(node -p "require('./package.json').version")"
test "$tag" = "v$version"
mkdir -p packages
mapfile -d '' projects < <(find DotNet~ Godot~ -type f -name '*.csproj' -print0 2>/dev/null || true)
test "${#projects[@]}" -gt 0
for project in "${projects[@]}"; do
dotnet restore "$project" --configfile NuGet.Config
dotnet pack "$project" --configuration Release --no-restore --output "$PWD/packages" --include-symbols --include-source
done
find packages -maxdepth 1 -name '*.nupkg' -type f | grep -q .
- name: Publish packages
shell: bash
run: |
set -euo pipefail
: "${NUGET_AUTH_TOKEN:?SHRINKSDK_PACKAGE_TOKEN is required}"
dotnet nuget push 'packages/*.nupkg' --api-key "$NUGET_AUTH_TOKEN" --source https://git.crash.work/api/packages/ShrinkSDK/nuget/index.json --skip-duplicate
if compgen -G 'packages/*.snupkg' > /dev/null; then
dotnet nuget push 'packages/*.snupkg' --api-key "$NUGET_AUTH_TOKEN" --source https://git.crash.work/api/packages/ShrinkSDK/nuget/index.json --skip-duplicate
fi
+27 -9
View File
@@ -15,22 +15,39 @@ jobs:
env:
NODE_AUTH_TOKEN: ${{ secrets.SHRINKSDK_PACKAGE_TOKEN }}
steps:
- name: Fetch tagged revision
- name: Fetch exact tagged release archive
env:
GITEA_REF: ${{ gitea.ref }}
shell: bash
run: |
set -eu
ref="${{ gitea.sha }}"
test -n "$ref"
git init .
git remote add origin "https://git.crash.work/ShrinkSDK/ShrinkNetwork.git"
git fetch --depth=1 origin "$ref"
git checkout --detach FETCH_HEAD
tag="${GITEA_REF#refs/tags/}"
case "$tag" in
v[0-9]*) ;;
*) echo "Expected a version tag ref, got: $GITEA_REF" >&2; exit 1 ;;
esac
export SHRINKSDK_ARCHIVE_URL="https://git.crash.work/ShrinkSDK/ShrinkNetwork/archive/${tag}.tar.gz"
node --input-type=module <<'NODE'
import { writeFile } from 'node:fs/promises';
const response = await fetch(process.env.SHRINKSDK_ARCHIVE_URL);
if (!response.ok) {
throw new Error(`Release archive download failed: ${response.status} ${response.statusText}`);
}
await writeFile('release.tar.gz', new Uint8Array(await response.arrayBuffer()));
NODE
mkdir release
tar -xzf release.tar.gz --strip-components=1 -C release
rm -f release.tar.gz
printf '%s' "$tag" > release/.shrink-sdk-release-tag
- name: Validate immutable release version
shell: bash
run: |
set -eu
tag="$(git describe --exact-match --tags HEAD)"
cd release
tag="$(cat .shrink-sdk-release-tag)"
version="$(node -p "require('./package.json').version")"
test "$tag" = "v$version"
npm pack --dry-run
@@ -40,10 +57,11 @@ jobs:
run: |
set -eu
: "${NODE_AUTH_TOKEN:?SHRINKSDK_PACKAGE_TOKEN is required}"
cd release
npmrc="$HOME/.npmrc"
cleanup() { rm -f "$npmrc"; }
trap cleanup EXIT
printf '%s\n' \
'registry=https://git.crash.work/api/packages/ShrinkSDK/npm/' \
'//git.crash.work/api/packages/ShrinkSDK/npm/:_authToken=${NODE_AUTH_TOKEN}' > "$npmrc"
npm publish --registry=https://git.crash.work/api/packages/ShrinkSDK/npm/
npm publish --registry=https://git.crash.work/api/packages/ShrinkSDK/npm/
+6 -1
View File
@@ -26,12 +26,17 @@ jobs:
shell: bash
run: |
set -eu
machine_id_file="/root/.local/share/unity3d/Unity/.machine-id"
if test -s "$machine_id_file"; then
cat "$machine_id_file" > /etc/machine-id
echo "Unity machine identity restored"
fi
git config --global url."https://ghfast.top/https://github.com/".insteadOf "https://github.com/"
unity_bin="$(command -v unity-editor || command -v unity || command -v Unity || true)"
test -n "$unity_bin"
"$unity_bin" \
-batchmode \
-nographics \
-quit \
-projectPath "$PWD/Development~/UnityProject" \
-runTests \
-testPlatform EditMode \
+8
View File
@@ -8,3 +8,11 @@
/Tools~/**/[Oo]bj/
*.user
*.DotSettings.user
/DotNet~/**/[Bb]in/
/DotNet~/**/[Oo]bj/
/Godot~/**/[Bb]in/
/Godot~/**/[Oo]bj/
/artifacts/
/packages/
!DotNet~/**/*.csproj
!Godot~/**/*.csproj
+4
View File
@@ -6,3 +6,7 @@ Tools~/
*.sln
*.user
*.DotSettings.user
DotNet~/
Godot~/
NuGet.Config
Directory.Build.props
@@ -10,6 +10,10 @@
],
"dependencies": {
"com.unity.test-framework": "1.1.33",
"com.cneicy.shrink-network": "file:../../.."
}
"com.cneicy.shrink-network": "file:../../..",
"com.cysharp.unitask": "https://github.com/Cysharp/UniTask.git?path=src/UniTask/Assets/Plugins/UniTask#7c0f199fe0d3fc528024488ccd671e6c7b27745b"
},
"testables": [
"com.cneicy.shrink-network"
]
}
+13
View File
@@ -0,0 +1,13 @@
<Project>
<PropertyGroup>
<LangVersion>latest</LangVersion>
<Nullable>enable</Nullable>
<Deterministic>true</Deterministic>
<ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
<Authors>ShrinkSDK</Authors>
<Company>ShrinkSDK</Company>
<RepositoryUrl>https://git.crash.work/ShrinkSDK</RepositoryUrl>
<IncludeSymbols>true</IncludeSymbols>
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
</PropertyGroup>
</Project>
+22
View File
@@ -0,0 +1,22 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>netstandard2.1</TargetFramework>
<EnableDefaultCompileItems>false</EnableDefaultCompileItems>
<AssemblyName>ShrinkNetwork.Runtime</AssemblyName>
<RootNamespace>ShrinkNetwork</RootNamespace>
<PackageId>ShrinkSDK.Network</PackageId>
<Version>0.3.0</Version>
<Description>ShrinkSDK messaging, RPC, permission and transport runtime.</Description>
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
<ShrinkCodeGenEnabled>false</ShrinkCodeGenEnabled>
</PropertyGroup>
<ItemGroup>
<Compile Include="..\Runtime\**\*.cs" />
<PackageReference Include="Kcp-CSharp" Version="1.0.8" />
<PackageReference Include="MessagePack" Version="3.1.8" />
<PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
<PackageReference Include="UniTask" Version="2.5.10" />
<PackageReference Include="ShrinkSDK.Runtime.Abstractions" Version="0.1.0" />
<PackageReference Include="ShrinkSDK.CodeGen" Version="0.1.0" PrivateAssets="compile;runtime;contentfiles;native" />
</ItemGroup>
</Project>
@@ -11,9 +11,8 @@ using UnityEngine;
public static class ShrinkDedicatedServerScaffoldGenerator
{
private const string LegacyMenuPath = "ShrinkSDK/Network/生成独立服务器脚手架";
private const string FullProjectMenuPath = "ShrinkSDK/Network/生成完整独立服务器工程";
private const string RefreshGeneratedMenuPath = "ShrinkSDK/Network/刷新独立服务器 Generated 合同";
private const string FullProjectMenuPath = "ShrinkSDK/网络/生成完整独立服务器工程";
private const string RefreshGeneratedMenuPath = "ShrinkSDK/网络/刷新独立服务器生成合同";
private const string TemplateRelativePath = "Assets/Modules/ShrinkNetwork/Editor/Scaffolding/ServerProjectTemplate";
private const string DefaultGeneratedServerRelativePath = "GeneratedServers/ShrinkNetwork.ServerHost";
private const string TemplateStampFileName = ".shrink-server-template.json";
@@ -115,7 +114,6 @@ public static class ShrinkDedicatedServerScaffoldGenerator
"/heartbeat"
};
[MenuItem(LegacyMenuPath)]
[MenuItem(FullProjectMenuPath)]
public static void GenerateFullProject()
{
+8
View File
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<packageSources>
<clear />
<add key="ShrinkSDK" value="https://git.crash.work/api/packages/ShrinkSDK/nuget/index.json" />
<add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
</packageSources>
</configuration>
+5 -3
View File
@@ -1,6 +1,8 @@
# ShrinkNetwork
一个 Unity C# 项目设计的轻量网络框架。重点不是“再包一层 Socket”,而是把消息声明、权限校验、RPC、序列化、传输层,以及独立服务器生成流程收拢到一套统一范式里。
一个可用于 Unity、Godot 和普通 .NET 宿主的轻量网络框架。重点不是“再包一层 Socket”,而是把消息声明、权限校验、RPC、序列化、传输层,以及独立服务器生成流程收拢到一套统一范式里。
Godot 和普通 .NET 项目安装 `ShrinkSDK.Network`;可打包源码位于 `DotNet~`,消息合同和 handler 注册由 `ShrinkSDK.CodeGen` 在构建时织入。
## ✨ 特性概览
@@ -220,8 +222,8 @@ public sealed class LanPlayerStateDelta : IShrinkNetworkMessage
Unity 菜单:
- `ShrinkSDK/Network/生成完整独立服务器工程`
- `ShrinkSDK/Network/刷新独立服务器 Generated 合同`
- `ShrinkSDK/网络/生成完整独立服务器工程`
- `ShrinkSDK/网络/刷新独立服务器生成合同`
生成结果默认输出到:
+5 -1
View File
@@ -1,17 +1,21 @@
#if UNITY_5_3_OR_NEWER
using UnityEngine;
#endif
namespace ShrinkNetwork
{
public static class ShrinkNetworkRuntime
{
public static ShrinkNetworkService Default { get; private set; }
public static ShrinkNetworkService Default { get; private set; } = null!;
static ShrinkNetworkRuntime()
{
RebuildDefault();
}
#if UNITY_5_3_OR_NEWER
[RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.SubsystemRegistration)]
#endif
private static void ResetOnPlayModeEnter()
{
RebuildDefault();
@@ -1,3 +1,5 @@
#nullable enable
using System;
using System.Net;
using System.Net.Sockets;
@@ -16,14 +18,14 @@ namespace ShrinkNetwork
private readonly ShrinkKcpTransportOptions _options;
private readonly object _syncRoot = new();
private CancellationTokenSource _cts;
private UdpClient _udpClient;
private ShrinkKcpPeer _peer;
private CancellationTokenSource? _cts;
private UdpClient? _udpClient;
private ShrinkKcpPeer? _peer;
private long _handshakeNonce;
private int _started;
private int _connected;
public ShrinkKcpClientTransport(string host, int port, ShrinkKcpTransportOptions options = null, long sessionId = 1)
public ShrinkKcpClientTransport(string host, int port, ShrinkKcpTransportOptions? options = null, long sessionId = 1)
{
if (string.IsNullOrWhiteSpace(host))
throw new ArgumentException("Host cannot be empty.", nameof(host));
@@ -39,7 +41,7 @@ namespace ShrinkNetwork
public bool IsStarted => Volatile.Read(ref _started) == 1;
public event Action<ShrinkNetworkTransportEvent> OnEvent;
public event Action<ShrinkNetworkTransportEvent>? OnEvent;
public void Start()
{
@@ -52,7 +54,7 @@ namespace ShrinkNetwork
_udpClient.Connect(_host, _port);
_handshakeNonce = CreateHandshakeNonce();
ReceiveLoopAsync(_cts.Token).Forget();
ReceiveLoopAsync(_udpClient, _cts.Token).Forget();
HandshakeLoopAsync(_cts.Token).Forget();
UpdateLoopAsync(_cts.Token).Forget();
}
@@ -145,7 +147,7 @@ namespace ShrinkNetwork
}
}
private async UniTaskVoid ReceiveLoopAsync(CancellationToken cancellationToken)
private async UniTaskVoid ReceiveLoopAsync(UdpClient udpClient, CancellationToken cancellationToken)
{
try
{
@@ -154,7 +156,7 @@ namespace ShrinkNetwork
UdpReceiveResult result;
try
{
result = await _udpClient.ReceiveAsync();
result = await udpClient.ReceiveAsync();
}
catch (ObjectDisposedException)
{
@@ -37,7 +37,6 @@ namespace ShrinkNetwork
private CancellationTokenSource? _cts;
private UdpClient? _udpClient;
private long _sessionIdGenerator;
private int _conversationIdGenerator;
public ShrinkKcpServerTransport(IPAddress listeningAddress, int port, ShrinkKcpTransportOptions? options = null)
{
+2 -2
View File
@@ -1,11 +1,11 @@
{
"name": "com.cneicy.shrink-network",
"version": "0.2.0",
"version": "0.3.0",
"displayName": "ShrinkNetwork",
"description": "面向 Unity 的轻量网络框架,提供会话、消息注册、RPC、权限控制,以及 TCP/KCP 传输抽象。",
"unity": "2022.3",
"dependencies": {
"com.cneicy.shrink-shared-codegen": "0.1.0",
"com.cneicy.shrink-shared-codegen": "0.1.1",
"com.cysharp.unitask": "2.5.10",
"com.unity.nuget.newtonsoft-json": "3.2.2"
},