diff --git a/.github/assets/logo.png b/.github/assets/logo.png new file mode 100644 index 0000000..f115c47 Binary files /dev/null and b/.github/assets/logo.png differ diff --git a/.github/assets/screenshot-mobile.png b/.github/assets/screenshot-mobile.png new file mode 100644 index 0000000..74db0f2 Binary files /dev/null and b/.github/assets/screenshot-mobile.png differ diff --git a/.github/assets/screenshot-tablet.png b/.github/assets/screenshot-tablet.png new file mode 100644 index 0000000..cec32b5 Binary files /dev/null and b/.github/assets/screenshot-tablet.png differ diff --git a/.github/assets/screenshot-web.png b/.github/assets/screenshot-web.png new file mode 100644 index 0000000..98a77e6 Binary files /dev/null and b/.github/assets/screenshot-web.png differ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index e168c04..f660e78 100644 --- a/README.md +++ b/README.md @@ -1,54 +1,69 @@ +
+ +SharpClient + # SharpClient -A .NET MAUI Blazor Hybrid client for connecting to text-based MUSH/MUD servers -over telnet, using [TelnetNegotiationCore](https://www.nuget.org/packages/TelnetNegotiationCore). -Android-primary. See [`docs/superpowers/specs`](docs/superpowers/specs) for the -design spec and visual-design brief. +**A modern, cross-platform client for MUSH & MUD text worlds.** + +[![CI](https://github.com/SharpMUSH/SharpClient/actions/workflows/ci.yml/badge.svg)](https://github.com/SharpMUSH/SharpClient/actions/workflows/ci.yml) [![Latest release](https://img.shields.io/github/v/release/SharpMUSH/SharpClient?include_prereleases&sort=semver&color=00b894&label=release)](https://github.com/SharpMUSH/SharpClient/releases) [![.NET 10](https://img.shields.io/badge/.NET-10-512BD4)](https://dotnet.microsoft.com) [![Platforms](https://img.shields.io/badge/platforms-Android%20%C2%B7%20Web-00b894)](#install) [![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE) + +
+ +SharpClient connects to text-based **MUSH / MUD** servers over Telnet, with the modern MU\* protocol stack and a clean Blazor interface. A single, fully-testable core drives both a native **Android** app and a **Blazor web** client, speaking Telnet through [TelnetNegotiationCore](https://github.com/HarryCordewener/TelnetNegotiationCore). + +## Features + +- **Modern MU\* protocols** — GMCP, MSSP, MSDP, NAWS and CHARSET, plus MXP and Pueblo, with EOR/GA prompt handling and UTF-8. +- **Rich rendering** — full ANSI/SGR colour & styling, MXP links, and MXP/Pueblo markup. +- **Automation** — per-world and per-character **triggers** and **aliases**. +- **Sessions that stay put** — multiple worlds & characters, saved connect credentials, and automatic **reconnect with backoff**. +- **Truly cross-platform** — one shared core behind a MAUI Blazor Hybrid Android app and a Blazor Server web client. +- **Built to be tested** — all connection, parsing and automation logic lives in a MAUI-free core with a TUnit suite. -## Installing on Android +## Screenshots -Signed APKs are attached to every [GitHub Release](https://github.com/SharpMUSH/SharpClient/releases). -You can sideload the `.apk` directly, but the easiest way to install **and stay -updated** is [Obtainium](https://github.com/ImranR98/Obtainium), which tracks this -repo's releases for you: + + + + + + +
SharpClient on a phone
Mobile		SharpClient on a tablet
Tablet		SharpClient in the browser
Web
+ +## Install + +### Android + +Signed APKs are attached to every [release](https://github.com/SharpMUSH/SharpClient/releases). You can sideload the `.apk` directly, but the easiest way to install **and stay updated** is [Obtainium](https://github.com/ImranR98/Obtainium), which tracks this repo's releases for you: 1. Install Obtainium. 2. Add an app with this source URL: ``` https://github.com/SharpMUSH/SharpClient ``` - or, from your phone, paste this Obtainium deep link (GitHub can't render it as - a clickable link, so copy it as-is): + or, on your phone, paste this deep link (GitHub can't render it as a clickable link, so copy it as-is): ``` obtainium://add/https://github.com/SharpMUSH/SharpClient ``` -3. Obtainium picks up the universal signed APK from each release and notifies you - when a new version ships. +3. Obtainium picks up the universal signed APK from each release and notifies you when a new version ships. -Each release ships a single universal APK, so no ABI/architecture filter is -needed. The APK's `versionName`/`versionCode` are derived from the release tag -(e.g. `v0.2` → `0.2`), so Obtainium and Android both see the correct version and -can update in place. If a release is marked **pre-release** on GitHub, enable -"include prereleases" for the app in Obtainium or it will be skipped. +Each release ships a **single universal APK** — no ABI/architecture filter needed — and its `versionName`/`versionCode` are derived from the release tag, so Obtainium and Android both see the correct version and can update in place. If a release is marked **pre-release** on GitHub, enable "include prereleases" for the app in Obtainium or it will be skipped. -## Solution layout +### Web -| Project | Kind | Purpose | -|---------|------|---------| -| `src/SharpClient.Core` | class library (`net10.0`) | Pure, MAUI-free logic: telnet connection, ANSI parsing, triggers/aliases, world/character model, sessions. Testable on plain .NET. | -| `src/SharpClient.UI` | Razor class library (`net10.0`) | Shared Blazor UI components. | -| `src/SharpClient.App` | MAUI Blazor Hybrid app (`net10.0-android`) | The device app head. Hosts the UI, provides platform implementations, wires DI. | -| `tests/SharpClient.Tests` | TUnit (`net10.0`) | Unit tests for the `Core` logic. | +```sh +dotnet run --project src/SharpClient.Web +``` + +Then open the printed URL (default ). -Shared build settings (warnings-as-errors, nullable, modern C#) live in -[`Directory.Build.props`](Directory.Build.props); the SDK is pinned to .NET 10 via -[`global.json`](global.json). +## Build from source -## Building & testing +The day-to-day loop needs no Android SDK — it runs on the `Core`, `Data` and `UI` projects and the test suites: ```sh -# Core + UI + Tests (no Android SDK required) -dotnet build SharpClient.slnx # note: excludes the App head if it can't build +dotnet build SharpClient.slnx # solution (skips the App head if it can't build) dotnet run --project tests/SharpClient.Tests # run the TUnit suite ``` @@ -58,21 +73,47 @@ dotnet run --project tests/SharpClient.Tests # run the TUnit suite dotnet build src/SharpClient.App/SharpClient.App.csproj -f net10.0-android ``` -Building `SharpClient.App` requires the `maui-android` workload plus the Android -SDK and **JDK 17** (the .NET for Android toolchain rejects newer JDKs). On this -machine those live at `~/Android/Sdk` and `~/Android/jdk-17.0.19+10`, wired in via -a gitignored `Directory.Local.props` (see `Directory.Local.props` for the property -names). On a fresh machine, install them with: +Building `SharpClient.App` requires the `maui-android` workload plus the Android SDK and **JDK 17** (the .NET for Android toolchain rejects newer JDKs). Machine-specific SDK/JDK paths are wired in via a gitignored `Directory.Local.props`. On a fresh machine: ```sh -# 1. Android SDK (accepts licenses, downloads platform-tools/build-tools/platform) +# Install the Android SDK (accepts licenses, downloads platform-tools/build-tools/platform) dotnet build src/SharpClient.App/SharpClient.App.csproj -f net10.0-android \ -t:InstallAndroidDependencies -p:AcceptAndroidSdkLicenses=True \ -p:AndroidSdkDirectory=$HOME/Android/Sdk -p:JavaSdkDirectory= -# 2. Point Directory.Local.props at your AndroidSdkDirectory and JavaSdkDirectory +# Then point Directory.Local.props at your AndroidSdkDirectory and JavaSdkDirectory. ``` -MAUI has no Linux desktop head, so the day-to-day dev loop runs through the -`Core` + `Tests` projects; the App head builds/deploys to an Android device or -emulator. +MAUI has no Linux desktop head, so on Linux the App head builds/deploys to an Android device or emulator while the inner loop stays on `Core` + `Tests`. + +## Architecture + +A MAUI-free core holds all the logic; the platform heads are thin hosts around it. + +| Project | Kind | Responsibility | +|---------|------|----------------| +| `src/SharpClient.Core` | class library (`net10.0`) | The engine: telnet connection, ANSI/MXP parsing, triggers & aliases, world/character model, sessions. Runs on plain .NET. | +| `src/SharpClient.Data` | class library (`net10.0`) | Persistence — worlds, characters and session history (EF Core / SQLite). | +| `src/SharpClient.UI` | Razor class library (`net10.0`) | Shared Blazor UI components. | +| `src/SharpClient.App` | MAUI Blazor Hybrid (`net10.0-android`) | Android app head — hosts the UI, provides platform services, wires DI. | +| `src/SharpClient.Web` | Blazor Server (`net10.0`) | Web client head. | +| `tests/*` | TUnit / bUnit | Unit tests for `Core` & `Data`, component tests for `UI`. | + +Shared build settings (warnings-as-errors, nullable, modern C#) live in [`Directory.Build.props`](Directory.Build.props); the SDK is pinned to .NET 10 via [`global.json`](global.json). The design spec and visual-design brief live in [`docs/superpowers/specs`](docs/superpowers/specs). + +## Tech stack + +.NET 10 · MAUI Blazor Hybrid · Blazor Server · TUnit & bUnit · EF Core (SQLite) · [TelnetNegotiationCore](https://github.com/HarryCordewener/TelnetNegotiationCore) + +## Contributing + +Issues and pull requests are welcome. The inner loop runs entirely on `Core` + `Tests` (no Android SDK required) — see [Build from source](#build-from-source). CI builds and runs the test suites on every push. + +## License + +Licensed under the [Apache License 2.0](LICENSE). + +## Acknowledgements + +- [TelnetNegotiationCore](https://github.com/HarryCordewener/TelnetNegotiationCore) — the Telnet / MU\* protocol engine. +- Part of the [SharpMUSH](https://github.com/SharpMUSH) project.