Fix Readme

This commit is contained in:
rainbownapkin 2022-06-26 01:17:39 +00:00
parent 0cabedbac6
commit 863b3960c8

266
README.md
View file

@ -27,156 +27,154 @@ You can reach out by bugging rainbownapkin on the ttn discord or ourfore.st, you
## Pineapple Express Indev Release Notes ## Pineapple Express Indev Release Notes
This is the first indev release for fore.st 1.1 Pineapple Express. This is the last push before the codebase is merged upstream with the newest version of cytube. Should probably get that done sooner than later. Heres a check list of the planned/completed features in this revision: This is the first indev release for fore.st 1.1 Pineapple Express. This is the last push before the codebase is merged upstream with the newest version of cytube. Should probably get that done sooner than later. Heres a check list of the planned/completed features in this revision:
-quick shit & bugfixes ✓ * quick shit & bugfixes ✓
--change markdown filters to require three symbols on each side, quickest fix for filters ✓ - change markdown filters to require three symbols on each side, quickest fix for filters ✓
--move refresh button to title bar ✓ - move refresh button to title bar ✓
--delete custom embed button, replace with button under generel "add video" button ✓ - delete custom embed button, replace with button under generel "add video" button ✓
--move playlist item count and length next to buttons & compact ui ✓ - move playlist item count and length next to buttons & compact ui ✓
--hide playlist frame and control from users who don't have permission to view playlist (no one can see the afterparty playlist except mods, why should they have the controls cluttering things up?) ✓ - hide playlist frame and control from users who don't have permission to view playlist (no one can see the afterparty playlist except mods, why should they have the controls cluttering things up?) ✓
--add "mention" to userlist dropdown menu ✓ - add "mention" to userlist dropdown menu ✓
--add "toke with" to userlist dropdown menu for shits n gigs ✓ - add "toke with" to userlist dropdown menu for shits n gigs ✓
--unlatch sync on pause and scrub, show sync button on titlebar when sync is unlatched, this wont support classic yt at the moment. Invidious support planned ✓ - unlatch sync on pause and scrub, show sync button on titlebar when sync is unlatched, this wont support classic yt at the moment. Invidious support planned ✓
--caption support for raw video (no saving captions in channel history just yet, this will be in the next update which will involve a rework/addition to the database) ✓ - caption support for raw video (no saving captions in channel history just yet, this will be in the next update which will involve a rework/addition to the database) ✓
--fix bugged airdate after "queue next" ✓ - fix bugged airdate after "queue next" ✓
--collapsing playlist items hides pref and airtime by default. Airdate on same line as title, airtime and pref below ✓ - collapsing playlist items hides pref and airtime by default. Airdate on same line as title, airtime and pref below ✓
--collapse/expand all playlist item button ✓ - collapse/expand all playlist item button ✓
--close playlist button ✓ - close playlist button ✓
--basic ui fixes/tweaks ✓ - basic ui fixes/tweaks ✓
--disabled !toke link embedding on emote alt text ✓ - disabled !toke link embedding on emote alt text ✓
--fix chatbar resizing on new message notification (might just by cytube+) ✓ - fix chatbar resizing on new message notification (might just by cytube+) ✓
--relicense to agpl ✓ - relicense to agpl ✓
--disable/remove unregistered channels ✓ - disable/remove unregistered channels ✓
--rename "legacy playlist buttons" to compact, fix location. This seems like it could be usable if not better than default ✓ - rename "legacy playlist buttons" to compact, fix location. This seems like it could be usable if not better than default ✓
--save temporary vids to channel library - save temporary vids to channel library
-slide out panel (not an end user feature in and of itself, however a common UI element used for most menus, made to be quick and ezpz ✓ * slide out panel (not an end user feature in and of itself, however a common UI element used for most menus, made to be quick and ezpz ✓
--function for opening, closing ✓ - function for opening, closing ✓
--allow switching menus on panel without having to open/close it ✓ - allow switching menus on panel without having to open/close it ✓
--pretty slide out animation ✓ - pretty slide out animation ✓
-improved poll UI ✓ * improved poll UI ✓
--poll panel auto-opens when poll starts ✓ - poll panel auto-opens when poll starts ✓
--button slides in chatbar from left, slides back after poll done ✓ - button slides in chatbar from left, slides back after poll done ✓
--on click toggles poll ui on left of chat menu ✓ - on click toggles poll ui on left of chat menu ✓
--improved poll chat announcements ~Original announcement removed. May implement once server whisper implemented. - improved poll chat announcements ~Original announcement removed. May implement once server whisper implemented.
-improved emote ui ✓ * improved emote ui ✓
--slide out emote ui ✓ - slide out emote ui ✓
--search bar ✓ - search bar ✓
--optional alphabet sort(default) ✓ - optional alphabet sort(default) ✓
--optional legacy emote menu available ✓ - optional legacy emote menu available ✓
-cytube+ ripout ✓ * cytube+ ripout ✓
--scroll to current item button ✓ - scroll to current item button ✓
--orientation buttons in title bar ✓ - orientation buttons in title bar ✓
--quick settings(icon next to emote button) ✓ - quick settings(icon next to emote button) ✓
---general pref - -general pref
----theme ✓ - --theme ✓
---playback pref ✓ - -playback pref ✓
----video orientation ✓ - --video orientation ✓
----toggle orientation buttons ✓ - --toggle orientation buttons ✓
----sync threshold (in seconds) ✓ - --sync threshold (in seconds) ✓
----youtube source (add after degoogling) ~ - --youtube source (add after degoogling) ~
---chat pref ✓ - -chat pref ✓
----use legacy cytube emote menu ✓ - --use legacy cytube emote menu ✓
----blink title on chat ✓ - --blink title on chat ✓
----chat notification sound ✓ - --chat notification sound ✓
----chat desktop notification ✓ - --chat desktop notification ✓
-trim/tidy default cytube commands * trim/tidy default cytube commands
--replace / with ! as defualt server-side command indicator to match tokebot and TTN commands. / will be used for future client-side commands ✓ - replace / with ! as defualt server-side command indicator to match tokebot and TTN commands. / will be used for future client-side commands ✓
---me ✓ - -me ✓
---sp ✓ - -sp ✓
---afk ✓ - -afk ✓
---poll ✓ - -poll ✓
---hpoll ✓ - -hpoll ✓
---mute ✓ - -mute ✓
---smute ✓ - -smute ✓
---unmute ✓ - -unmute ✓
---kick ✓ - -kick ✓
---ban ✓ - -ban ✓
---ipban ✓ - -ipban ✓
---clear ✓ - -clear ✓
---clean ✓ - -clean ✓
---cleantitle ✓ - -cleantitle ✓
--remove/consolidate/add to commands ✓ - remove/consolidate/add to commands ✓
---say -> announce(change tokebot modflair CSS to announce CSS, make normal modflair for bot/admin rank) ✓ - -say -> announce(change tokebot modflair CSS to announce CSS, make normal modflair for bot/admin rank) ✓
---remove kickanons ✓ - -remove kickanons ✓
---remove d (drink) ✓ - -remove d (drink) ✓
---add user specific function to clear ('!clear <username>' to clear chats by said user) ✓ - -add user specific function to clear ('!clear <username>' to clear chats by said user) ✓
--Merge Upstream to newest cytube commit * Merge Upstream to newest cytube commit
-improved server-whisper system * improved server-whisper system
--public leave/join messages - public leave/join messages
--server-whisper target parameter for user specific whispers - server-whisper target parameter for user specific whispers
--server-whisper name - server-whisper name
-getplaylistlinks outputs in fpanel * getplaylistlinks outputs in fpanel
--I mean its pretty fucking simple I dont know how you can screw this one up bud. - I mean its pretty fucking simple I dont know how you can screw this one up bud.
--ezpzlmnsqze - ezpzlmnsqze
-ui sizing overhaul * ui sizing overhaul
--rip out all but the ONE TRUE layout. It's not 2014 anymore, one layout with dynamic elements will get you further than multiple static ones. - rip out all but the ONE TRUE layout. It's not 2014 anymore, one layout with dynamic elements will get you further than multiple static ones.
--chat/player sized to fit canvas with navbar (remove -+ buttons on player) - chat/player sized to fit canvas with navbar (remove -+ buttons on player)
--theatre mode toggle icon on title bar (hides navbar, player/chat takes up entire screen) - theatre mode toggle icon on title bar (hides navbar, player/chat takes up entire screen)
--click to drag chat/player split - click to drag chat/player split
--shade player (hide and unload video, titel bar shows title and unshade icon only) - shade player (hide and unload video, titel bar shows title and unshade icon only)
--shade chat (hide chat box, message box, send button. chat header bar collapses, retains user count and expansion arrows. Userlist/poll open/close is independent.) - shade chat (hide chat box, message box, send button. chat header bar collapses, retains user count and expansion arrows. Userlist/poll open/close is independent.)
--popout video button - popout video button
--popout chat button - popout chat button
--remove legacy cytube themes. If they wheren't compatible after the emote panel, they certainly won't be now lmao - remove legacy cytube themes. If they wheren't compatible after the emote panel, they certainly won't be now lmao
-decaffeinate player.js * decaffeinate player.js
--Coffee script was a bad idea then, and it makes even less sense now. - Coffee script was a bad idea then, and it makes even less sense now.
--fuck me its just javascript with worse syntax, no real debugging tools, and build times - fuck me its just javascript with worse syntax, no real debugging tools, and build times
--literally fucking why though?(I guess it made sense before ES6 but still fuck me) - literally fucking why though?(I guess it made sense before ES6 but still fuck me)
-degoogling * degoogling
--yt-dlp backend for serverside metadata acquisition of youtube videos w/o registered API key or google account - yt-dlp backend for serverside metadata acquisition of youtube videos w/o registered API key or google account
--potentially leverage yt-dlp backend for other media sources - potentially leverage yt-dlp backend for other media sources
--invidious embed support for youtube video playback - invidious embed support for youtube video playback
--youtube source in user prefrences (three or four invidious instances from different countries/continents, official youtube embed, or custom invidious instance) - youtube source in user prefrences (three or four invidious instances from different countries/continents, official youtube embed, or custom invidious instance)
-autobump * autobump
--sepearate bump lists, based on js/txt files at first, will be stored in db next update (may use multiple at once) - sepearate bump lists, based on js/txt files at first, will be stored in db next update (may use multiple at once)
--skip next bump/disable bumping - skip next bump/disable bumping
--bump frequency (default: 1) - bump frequency (default: 1)
--queue method: random from last-half, round-robin, full random - queue method: random from last-half, round-robin, full random
--override next bump - override next bump
--require video be at least 4 minutes to add bump (mods can override from bump menu) - require video be at least 4 minutes to add bump (mods can override from bump menu)
-merge tokebot into ourfore.st codebase, one server instead of two. * merge tokebot into ourfore.st codebase, one server instead of two.
--profile and userlist entry - profile and userlist entry
---bot specific rank - -bot specific rank
--reset cooldown accessible from modmenu (quiet and loud, quiet by default) - reset cooldown accessible from modmenu (quiet and loud, quiet by default)
--log tokes w/ date to file. This will be switched to mariadb in the next update - log tokes w/ date to file. This will be switched to mariadb in the next update
--tokefile, list of usernames with toke count. This will be switched to mariadb in the next update - tokefile, list of usernames with toke count. This will be switched to mariadb in the next update
--total tokes listed on profile tooltip - total tokes listed on profile tooltip
* mod panel
- button on chatbar
- mod message (sends message to all active mods)
- new poll button
- autobump control tab
- tokebot control tab
- playlist tab
- modflair
- open playlist below video (if closed, otherwise this does not appear)
- open playlist below video by default
-mod panel * merge fore.st theme changes to fore.st dusk, consider moving some of them over to cytube.css for easier management
--button on chatbar
--mod message (sends message to all active mods)
--new poll button
--autobump control tab
--tokebot control tab
--playlist tab
--modflair
--open playlist below video (if closed, otherwise this does not appear)
--open playlist below video by default
* extra shit(probs wait til next update, or hotfix)
-merge fore.st theme changes to fore.st dusk, consider moving some of them over to cytube.css for easier management - short chats (acronyms, emoji, single letters/numbers/symbols) pop in over video from left starting at top left, overflow pops in below, instead of in chat box. Chats slide back up into top of vid after 2s. (optional, default on)
- basic mod chat (save to mod channel + pm all online mods)
-extra shit(probs wait til next update, or hotfix) - basic profile page (in side panel)
--short chats (acronyms, emoji, single letters/numbers/symbols) pop in over video from left starting at top left, overflow pops in below, instead of in chat box. Chats slide back up into top of vid after 2s. (optional, default on) - css variables in theme for ez customizablity
--basic mod chat (save to mod channel + pm all online mods) - user themes
--basic profile page (in side panel) - change background to other themes background or img from url(theme background by default)
--css variables in theme for ez customizablity - native odysee support (no raw embed)
--user themes
--change background to other themes background or img from url(theme background by default)
--native odysee support (no raw embed)
## License ## License