Browse Source

add roadmap

Noah Vogt 5 days ago
parent
commit
ca1d1a3ede
1 changed files with 6 additions and 1 deletions
  1. 6 1
      README.md

+ 6 - 1
README.md

@@ -7,7 +7,7 @@ An [OBS](https://github.com/obsproject/obs-studio) plugin to display the status
 The [offical obs plugin template](https://github.com/obsproject/obs-plugintemplate) was used to create this plugin.
 The [offical obs plugin template](https://github.com/obsproject/obs-plugintemplate) was used to create this plugin.
 
 
 ## How it works
 ## How it works
-This plugin listens in on a WebSocket server on `ws://localhost:8765` from which it receives messages like:
+This plugin listens in on a websocket server on `ws://localhost:8765` from which it receives messages like:
 ```json
 ```json
 {
 {
   "recording": true,
   "recording": true,
@@ -30,3 +30,8 @@ It then adds a dock on the obs studio interface titled *CD Rec Status* that disp
 - follow the [offical obs build instructions](https://github.com/obsproject/obs-studio/wiki/Install-Instructions#building-obs-studio) for your prefered platform
 - follow the [offical obs build instructions](https://github.com/obsproject/obs-studio/wiki/Install-Instructions#building-obs-studio) for your prefered platform
 
 
 You now have compiled OBS with the plugin. But you probably don't want to rebuild obs after every new release. So just find the `cd-rec-status.so` file in the build directory and put it into a plugin directory you can point your regular obs installation to. If you are unsure on how to structure the plugin directory, have a look at the releases on this github repository.
 You now have compiled OBS with the plugin. But you probably don't want to rebuild obs after every new release. So just find the `cd-rec-status.so` file in the build directory and put it into a plugin directory you can point your regular obs installation to. If you are unsure on how to structure the plugin directory, have a look at the releases on this github repository.
+
+## Roadmap
+Possible changes in future releases:
+- add de locale
+- allow the configuration of hostname + port of the websocket via the obs gui