Compare commits

...

2 commits

Author SHA1 Message Date
6f0c932f9c license cc0 (#3)
she's in the commons now
Co-authored-by: maren <git@stillgreenmoss.net>
Co-committed-by: maren <git@stillgreenmoss.net>
2024-05-03 02:55:38 +00:00
8d976bfe63 remove bunkchat scripts (#2)
bunkdeck is now the repo for nice tools on top of bunkchat

includes `bunkdeck` for scripting terminal multiplexing and `delete.sh` to add to crontab for periodic flushing of chatlog

tested:
- [x] local
- [x] in tilde

Co-authored-by: maren <git@stillgreenmoss.net>
Reviewed-on: #2
Reviewed-by: maren <git@stillgreenmoss.net>
Co-authored-by: oxaliq <git@oxaliq.net>
Co-committed-by: oxaliq <git@oxaliq.net>
2024-04-22 20:45:27 +00:00
8 changed files with 277 additions and 148 deletions

122
LICENSE.txt Normal file
View file

@ -0,0 +1,122 @@
Creative Commons Legal Code
CC0 1.0 Universal
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
HEREUNDER.
Statement of Purpose
The laws of most jurisdictions throughout the world automatically confer
exclusive Copyright and Related Rights (defined below) upon the creator
and subsequent owner(s) (each and all, an "owner") of an original work of
authorship and/or a database (each, a "Work").
Certain owners wish to permanently relinquish those rights to a Work for
the purpose of contributing to a commons of creative, cultural and
scientific works ("Commons") that the public can reliably and without fear
of later claims of infringement build upon, modify, incorporate in other
works, reuse and redistribute as freely as possible in any form whatsoever
and for any purposes, including without limitation commercial purposes.
These owners may contribute to the Commons to promote the ideal of a free
culture and the further production of creative, cultural and scientific
works, or to gain reputation or greater distribution for their Work in
part through the use and efforts of others.
For these and/or other purposes and motivations, and without any
expectation of additional consideration or compensation, the person
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
is an owner of Copyright and Related Rights in the Work, voluntarily
elects to apply CC0 to the Work and publicly distribute the Work under its
terms, with knowledge of his or her Copyright and Related Rights in the
Work and the meaning and intended legal effect of CC0 on those rights.
1. Copyright and Related Rights. A Work made available under CC0 may be
protected by copyright and related or neighboring rights ("Copyright and
Related Rights"). Copyright and Related Rights include, but are not
limited to, the following:
i. the right to reproduce, adapt, distribute, perform, display,
communicate, and translate a Work;
ii. moral rights retained by the original author(s) and/or performer(s);
iii. publicity and privacy rights pertaining to a person's image or
likeness depicted in a Work;
iv. rights protecting against unfair competition in regards to a Work,
subject to the limitations in paragraph 4(a), below;
v. rights protecting the extraction, dissemination, use and reuse of data
in a Work;
vi. database rights (such as those arising under Directive 96/9/EC of the
European Parliament and of the Council of 11 March 1996 on the legal
protection of databases, and under any national implementation
thereof, including any amended or successor version of such
directive); and
vii. other similar, equivalent or corresponding rights throughout the
world based on applicable law or treaty, and any national
implementations thereof.
2. Waiver. To the greatest extent permitted by, but not in contravention
of, applicable law, Affirmer hereby overtly, fully, permanently,
irrevocably and unconditionally waives, abandons, and surrenders all of
Affirmer's Copyright and Related Rights and associated claims and causes
of action, whether now known or unknown (including existing as well as
future claims and causes of action), in the Work (i) in all territories
worldwide, (ii) for the maximum duration provided by applicable law or
treaty (including future time extensions), (iii) in any current or future
medium and for any number of copies, and (iv) for any purpose whatsoever,
including without limitation commercial, advertising or promotional
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
member of the public at large and to the detriment of Affirmer's heirs and
successors, fully intending that such Waiver shall not be subject to
revocation, rescission, cancellation, termination, or any other legal or
equitable action to disrupt the quiet enjoyment of the Work by the public
as contemplated by Affirmer's express Statement of Purpose.
3. Public License Fallback. Should any part of the Waiver for any reason
be judged legally invalid or ineffective under applicable law, then the
Waiver shall be preserved to the maximum extent permitted taking into
account Affirmer's express Statement of Purpose. In addition, to the
extent the Waiver is so judged Affirmer hereby grants to each affected
person a royalty-free, non transferable, non sublicensable, non exclusive,
irrevocable and unconditional license to exercise Affirmer's Copyright and
Related Rights in the Work (i) in all territories worldwide, (ii) for the
maximum duration provided by applicable law or treaty (including future
time extensions), (iii) in any current or future medium and for any number
of copies, and (iv) for any purpose whatsoever, including without
limitation commercial, advertising or promotional purposes (the
"License"). The License shall be deemed effective as of the date CC0 was
applied by Affirmer to the Work. Should any part of the License for any
reason be judged legally invalid or ineffective under applicable law, such
partial invalidity or ineffectiveness shall not invalidate the remainder
of the License, and in such case Affirmer hereby affirms that he or she
will not (i) exercise any of his or her remaining Copyright and Related
Rights in the Work or (ii) assert any associated claims and causes of
action with respect to the Work, in either case contrary to Affirmer's
express Statement of Purpose.
4. Limitations and Disclaimers.
a. No trademark or patent rights held by Affirmer are waived, abandoned,
surrendered, licensed or otherwise affected by this document.
b. Affirmer offers the Work as-is and makes no representations or
warranties of any kind concerning the Work, express, implied,
statutory or otherwise, including without limitation warranties of
title, merchantability, fitness for a particular purpose, non
infringement, or the absence of latent or other defects, accuracy, or
the present or absence of errors, whether or not discoverable, all to
the greatest extent permissible under applicable law.
c. Affirmer disclaims responsibility for clearing rights of other persons
that may apply to the Work or any use thereof, including without
limitation any person's Copyright and Related Rights in the Work.
Further, Affirmer disclaims responsibility for obtaining any necessary
consents, permissions or other rights required for any use of the
Work.
d. Affirmer understands and acknowledges that Creative Commons is not a
party to this document and has no duty or obligation with respect to
this CC0 or use of the Work.

View file

@ -1,25 +1,26 @@
#!/bin/bash #!/bin/sh -e
set -e
heedPane="bunkdeck:0.0" sessionname=bunkdeck
proclaimPane="bunkdeck:0.1" heedPane=bunkdeck:0.0
shellPane="bunkdeck:0.2" proclaimPane=bunkdeck:0.1
shellPane=bunkdeck:0.2
function isExistingDeck { isExistingDeck () {
set +e if tmux has -t $sessionname ; then
sessions=$(tmux list-sessions)
set -e
if [[ $sessions == *"bunkdeck"* ]]; then
return 0 return 0
else else
return 1 return 1
fi fi
} }
function startNewDeck { attachToDeck () {
tmux new -d -s bunkdeck heed # does not currently protect against nesting sessions (tmux does this for us)
tmux split-window -h -t bunkdeck -p 70 tmux attach-session -d -t bunkdeck
}
startNewDeck () {
tmux new -d -s $sessionname heed
tmux split-window -h -t $sessionname -p 70
tmux split-window -t $heedPane -v -p 3 tmux split-window -t $heedPane -v -p 3
tmux send-keys -t $proclaimPane 'proclaim' C-m tmux send-keys -t $proclaimPane 'proclaim' C-m
tmux send-keys -t $shellPane 'cowsay "press [CTRL+b then o] to cycle through panes"' C-m tmux send-keys -t $shellPane 'cowsay "press [CTRL+b then o] to cycle through panes"' C-m
@ -32,11 +33,25 @@ function startNewDeck {
tmux attach -t $shellPane tmux attach -t $shellPane
} }
function killDeck { killDeck () {
tmux kill-session -t bunkdeck if isExistingDeck; then
tmux kill-session -t $sessionname
else
echo "you don't have bunkdeck running!"
fi
} }
function growPane { leaveDeck () {
# currently assumes that bunkdeck is only session running
# if bunkdeck leave is issued from within another session, silent failure occurs
if isExistingDeck && [ "${TMUX}" != "" ]; then
tmux detach -s $sessionname
echo "you are not inside bunkdeck! for help:"
echo "$ bunkdeck help"
fi
}
growPane () {
case $2 in case $2 in
shell) shell)
tmux resize-pane -t $shellPane -L "$3" tmux resize-pane -t $shellPane -L "$3"
@ -62,7 +77,7 @@ function growPane {
esac esac
} }
function shrinkPane { shrinkPane () {
case $2 in case $2 in
shell) shell)
tmux resize-pane -t $shellPane -R "$3" tmux resize-pane -t $shellPane -R "$3"
@ -88,6 +103,28 @@ function shrinkPane {
esac esac
} }
helpText () {
usageText
echo
echo "help:"
echo
echo " movement:"
echo " bunkdeck gives you three panes, 'proclaim' to chat, 'heed' to read chats"
echo " and 'shell' to do whatever you want!"
echo " to move between panes you press [CTL + b] at the same time"
echo " then [arrow key] to move to a new pane, or 'o' to cycle around"
}
usageText () {
echo "usage: bunkdeck [COMMAND]"
echo
echo "commands:"
echo " (none) attach to existing bunkdeck or start new one"
echo " kill kill running bunkdeck"
echo " leave close bunkdeck without killing it"
echo " grow grow the size of a bunkdeck window"
echo " shrink shrink the size of a bunkdeck window"
}
case $1 in case $1 in
@ -96,26 +133,24 @@ case $1 in
;; ;;
"") "")
if isExistingDeck; then if isExistingDeck; then
tmux attach-session -t bunkdeck attachToDeck
else else
startNewDeck startNewDeck
fi fi
;; ;;
leave)
leaveDeck
;;
grow) grow)
growPane "$@" growPane "$@"
;; ;;
shrink) shrink)
shrinkPane "$@" shrinkPane "$@"
;; ;;
help)
helpText
;;
*) *)
echo "usage: bunkdeck [COMMAND]" usageText
echo
echo "commands:"
echo " (none) attach to existing bunkdeck or start new one"
echo " kill kill running bunkdeck"
echo " grow grow the size of a bunkdeck window"
echo " shrink shrink the size of a bunkdeck window"
exit 1
;; ;;
esac esac

6
delete.sh Normal file
View file

@ -0,0 +1,6 @@
#!/bin/sh -e
chatlog=/var/log/bunkchat/chat.log
chattr -a $chatlog
echo > $chatlog
chattr +a $chatlog

12
heed
View file

@ -1,12 +0,0 @@
#!/bin/sh -e
clear
figlet -f future heed - bunkchat
echo "#######################################################################"
echo "# Take heed, $USER! This is a group chat with everyone on the server! #"
echo "# You can view earlier chat with 'scry' or 'less /srv/bunkchat.txt' #"
echo "#######################################################################"
echo
tail -f /srv/bunkchat.txt

13
install.sh Executable file
View file

@ -0,0 +1,13 @@
#!/bin/sh -e
# TODO
# check for tmux and cowsay
# if not prompt and exit
# pull in bunkchat
# run bunkchat install script
# install buckdeck in /usr/local/bin
# prompt user to install delete.sh in /root/crontab-scripts/delete-bunkchat.sh
# prompt with crontab config

View file

@ -1,29 +0,0 @@
#!/bin/bash -e
# make username uppercase
username=$(echo "$USER" | tr '[:lower:]' '[:upper:]')
timezone="America/New_York"
declare prompt
makeSlug () {
# make time and date
time=$(TZ=${timezone} date +%I:%M%p)
date=$(TZ=${timezone} date +%m/%d)
# make name/time string
prompt="${username}-${date}-${time}"
}
# enter bunkchat mode (clear the screen)
clear
while true
do
figlet -f future proclaim - bunkchat
echo "You may view old chat with 'scry', heathen."
echo "-------------------------------------------"
read -r -p "speak to the server: " text
makeSlug
echo "${prompt}: $text" >> /srv/bunkchat.txt
clear
done

View file

@ -6,11 +6,8 @@ tmux wraps some hand-rolled local chat scripts, and the`bunkdeck` command starts
bunkdeck is comprised of these lil things: bunkdeck is comprised of these lil things:
* `bunkdeck` - run this command to start the interface * `bunkdeck` - run this command to start the interface
* `proclaim` - post in chat * `bunkchat` - the actual chat functionality [git](https://git.bunk.computer/bunk/bunkchat)
* `heed` - read the chat
* `scry` - read the old chat
on the server, these are all installed in `/usr/local/bin` so everyone can run them on the server, these are all installed in `/usr/local/bin` so everyone can run them
the file they all interact with, `/srv/bunkchat.txt` has permissions such that everyone can read and write to it the file they all interact with, `/var/log/bunkchat/chat.log` is append-only

3
scry
View file

@ -1,3 +0,0 @@
#!/bin/sh -e
less /srv/bunkchat.txt