diff --git a/README.md b/README.md index 9ffb9e45..1ed17978 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,8 @@ The ***wtv minisrv***, or "***zefie_wtvp_minisrv***" project is a node.js project that provides a mini WebTV Server, aiming for full WTVP (WebTV Protocol) support. This open source server is in beta status. Use at your own risk. +# Note: This is the `dev` branch. It offers more features and bug fixes than `master`. Until the release of v1.0 (and the removal of this message), it is suggested you download from this branch + [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) ### Current status: @@ -18,12 +20,20 @@ This open source server is in beta status. Use at your own risk. - Custom Tellyscripts *(not yet customizable though)* - Flat file client session store and registration system - wtv-lzpf compression support by eMac (99.9%) +- wtv-favorites support +- wtv-news support (WIP) +- wtv-mail (within same server only) +- "PC Services" (node express with minisrv custom script processing) +- "ViewerGen" Generate "WebTV Viewer" (Windows WebTV Sim) with unique SSIDs ### Current issues: - Mis-configuring wtv-disk:/sync DiskMaps may cause units to delete contents of partitions (need more info) ### Feature Todo: - TellyScript generation and/or manipulation without external dependancies +- Finish wtv-news, complete with upstream integration support (cross-minisrv usenet) +- Finish wtv-guide +- Add wtv-author (Pagebuilder) - ~~wtv-setup and bgm support~~ ***Done [v0.9.23](https://github.com/zefie/zefie_wtvp_minisrv/releases/tag/v0.9.23)*** - ~~wtv-cookie full support~~ ***Done [v0.9.13](https://github.com/zefie/zefie_wtvp_minisrv/releases/tag/v0.9.13)*** - ~~Flashrom flashing for bf0app old classic~~ ***Done [v0.9.9](https://github.com/zefie/zefie_wtvp_minisrv/releases/tag/v0.9.9)*** @@ -32,14 +42,15 @@ This open source server is in beta status. Use at your own risk. - ~~Implement HTTP proxy (needs to be able to defluff most of the web, think retro WAP converter)~~ ***Done [v0.7.1](https://github.com/zefie/zefie_wtvp_minisrv/releases/tag/v0.7.1)*** ### How To Use: -- Install [node.js](https://nodejs.org/en/download/). Be sure to say `Yes` when asked about `Chocolatey`. +- Install [node.js](https://nodejs.org/en/download/). If on Windows, be sure to say `Yes` when asked about `Chocolatey`. +- Install git (if on Windows, install from [Git for Windows](https://gitforwindows.org/) - Download a snapshot (either of master, or of any commit/branch/relase/tag etc) - Extract zip somewhere and enter that directory with a command prompt - Enter `zefie_wtvp_minisrv` subdirectory - Verify you are in the same directory as `app.js`, then run `npm install` - Check any configuration. Create your override `user_config.json`. Especally `service_ip`. See [user_config_README.md](user_config_README.md) and [user_config.example.json](zefie_wtvp_minisrv/user_config.example.json) for more information. - **Note:** The intended use is for all custom config to be in `user_config.json` and any custom service files to go in `UserServiceVault`. If you do not care about potential issues with future `git pull`, and will manually add new upstream `config.json` entries, you could use the standard `ServiceVault` and `config.json` -- Run `npm start` (note: if you are using node version 17 or newer, and are getting errors, try `npm start17`) +- Run `npm start` (**note**: if you are using node version 17 or newer, and are getting errors, try `npm start17`) - If you have trouble running it on Windows, try a Linux machine, Windows may need a full development enviroment or extra steps. - Test with a WebTV Viewer or connect with a real box - To connect with a real box, you will need to open ports in your firewall and have a way to connect your WebTV (and preferably reroute 10.0.0.1 to the server) @@ -49,4 +60,11 @@ This open source server is in beta status. Use at your own risk. - [Report Bugs](https://github.com/zefie/zefie_wtvp_minisrv/issues) - [Add a Feature and send a Pull Request](https://github.com/zefie/zefie_wtvp_minisrv/pulls) - Write and submit better documentation than I created (see Pull Request above) -- [Support financially on Patreon](https://www.patreon.com/zefie) +- **Content Creators**: Shout out this project, and my YouTube Channel (https://www.youtube.com/zefievideo) +- Financially Support: + - **Companies**: Reach out to biz@zefie.net to sponsor this project + - [Subscribe on Patreon](https://www.patreon.com/zefie) + - One-Time Support: + - [CashApp $altimit](https://cash.app/$altimit) + - Chime: $zefie + - [Credit Card or PayPal (powered by StreamElements)](https://zef.pw/ttv_tip)