Update README.md

e3ndr · Oct 3, 2023 · db12d1a · db12d1a
1 parent 1ff54b5
commit db12d1a
Showing 1 changed file with 20 additions and 27 deletions.
diff --git a/README.md b/README.md
@@ -6,20 +6,21 @@ Cool little media server, WIP :^)
 
 ## Features
 
--   Can transcode to a wide variety of formats.
--   Doesn't stream unnecessary data to the client, saving bandwidth (e.g an unused 5.1 surround sound audio stream)
--   Fast and light-weight.
--   Can stream media over FTP or HTTP, with transcoding enabled on both.
--   Supports CUDA/NVENC acceleration.
--   Supports WiiMC.
+- Can transcode to a wide variety of formats.
+- Fast and light-weight.
+- Can stream media over FTP or HTTP, with transcoding enabled on both.
+- Supports CUDA/NVENC acceleration.
+- Supports WiiMC.
 
 ### WiiMC
 
-Just add these two lines to your `onlinemedia.xml` file:
+In your config, enable `services.special`.
+
+Then, add these two lines to your `onlinemedia.xml` file:
 
 ```xml
-<link name="Athena Media Server - Search" type="search" addr="http://localhost:8080/v1/athena/api/wiimc/search?q="/>
-<link name="Athena Media Server" addr="http://localhost:8080/v1/athena/api/wiimc/list"/>
+<link name="Athena Media Server - Search" type="search" addr="http://<ip>:8128/wiimc/search?q="/>
+<link name="Athena Media Server" addr="http://<ip>:8128/wiimc/list"/>
 ```
 
 [Here's](https://i.e3ndr.xyz/1mBTjdAJwr8M__1666969284/WiiMC%20Support.mp4) what it looks like in action.
@@ -30,26 +31,18 @@ Athena will generate a faux file list when a client connects using the encoding
 
 ## Parameters
 
-| HTTP       | FTP | What is it used for?                                                              | Possible values                          |
-| ---------- | --- | --------------------------------------------------------------------------------- | ---------------------------------------- |
-| format     | f   | Selects a container to be used.                                                   | `MP4`, `SWF`,`FLV`, `OGG`, `WEBM`, `MKV` |
-| quality    | q   | Sets the video quality.                                                           | `SOURCE`, `UHD`, `FHD`, `HD`, `SD`, `LD` |
-| videoCodec | vc  | Sets the video codec to be used IF the video quality is anything except `SOURCE`. | `H264`, `HEVC`, `SPARK`, `THEORA`, `VP8` |
-| audioCodec | ac  | Sets the audio codec to be used.                                                  | `SOURCE`, `AAC`, `MP3`, `OPUS`           |
-
-### Generating Flash-compatible output
-
-Some older clients may not support HTML5 video but they may still support Flash (e.g the Wii or PSP). Here's a table of parameters you can use to support different versions of flash:
+| HTTP       | FTP | What is it used for?                                                              | Possible values                                                |
+| ---------- | --- | --------------------------------------------------------------------------------- | -------------------------------------------------------------- |
+| format     | f   | Selects a container to be used.                                                   | `MP4`, `TS`, `MKV`                                             |
+| quality    | q   | Sets the video quality.                                                           | `UHD`, `FHD`, `HD`, `SD`, `LD`                                 |
+| videoCodec | vc  | Sets the video codec to be used IF the video quality is anything except `SOURCE`. | `SOURCE`, `H264_BASELINE`,, `H264_HIGH` `HEVC`, `SPARK`, `AV1` |
+| audioCodec | ac  | Sets the audio codec to be used.                                                  | `SOURCE`, `AAC`, `MP3`, `OPUS`                                 |
 
-| Version | Note                           | Parameters                                 |
-| ------- | ------------------------------ | ------------------------------------------ |
-| 6+      | Should be supported by the PSP | format=SWF&videoCodec=SPARK&audioCodec=MP3 |
-| 7+      | Should be supported by the Wii | format=FLV&videoCodec=SPARK&audioCodec=MP3 |
-| 9+      |                                | format=FLV&videoCodec=H264&audioCodec=AAC  |
+### Support for older devices
 
-Your mileage may vary, but in do play around with the parameters and let me know what you can get working with Athena! If you're unsure of what your client supports then you can open up [WebMediaTest](https://wmt.e3ndr.xyz/) on your device (or run it locally to bypass https) and start playing the samples.
+Your mileage may vary, but do play around with the parameters and let me know what you can get working with Athena! If you're unsure of what your client supports then you can open up [WebMediaTest](https://wmt.e3ndr.xyz/) on your device (or run it locally to bypass https) and use the tester tables to detect what your device supports.
 
 ## Prerequisites
 
--   Requires FFMPEG installed on your path, Google it ;)
--   Requires Java 11 or greater. You can grab that [here](https://adoptium.net/).
+- Requires FFMPEG installed on your path, Google it ;)
+- Requires Java 11 or greater. You can grab that [here](https://adoptium.net/).