This README is the one indexed from the repository at its latest ref, not from the tag for this version.

privateparlor

A rewrite of secretlounge-ng, a bot to make an anonymous group chat on Telegram. Written in Crystal with the aim of being a fast, memory efficient, and featureful alternative.

Updates posted on Telegram

Installation

git clone https://github.com/Charibdys/Private-Parlor.git
cd privateparlor
shards install
shards build --release

BotFather Setup

1. Start a conversation with BotFather
2. Make a new bot with /newbot and answer the prompts
3. /setprivacy: enabled
4. /setjoingroups: disabled
5. /setcommands: paste the following command list here

Command list

start - Join the chat (start receiving messages)
stop - Leave the chat (stop receiving messages)
leave - Alias of stop
info - Get info about your account
users - Show the number of users in the chat
version - Get the version and a link to the source code
togglekarma - Toggle karma notifications
toggledebug - Toggle debug mode (sends messages back to you)
tripcode - Set or view your tripcode
rules - Show the rules of this chat
sign - Sign a message with your username
tsign - Sign a message with your tripcode
s - Alias of sign
t - Alias of tsign

Usage

1. Rename config.yaml.copy to config.yaml
2. Edit config file, it should at least have the API token for your bot and a path to a SQLite database
3. Run the binary found in bin/

Development

The following features are planned and being worked on:

• [ ] Relay message types
  • [x] Text
  • [x] Photos
  • [X] Albums
  • [x] Videos
  • [x] Files/Documents
  • [x] GIFs
  • [x] Stickers
  • [x] Polls
  • [x] Locations/Venues
  • [ ] Contacts
  • [x] Forwards
• [ ] Admin commands
  • [X] Delete
  • [X] Delete all
  • [X] Remove
  • [X] Warn
  • [X] Setting rules
  • [X] User info
  • [X] Blacklist
  • [X] Promotion
  • [X] Demotion
  • [ ] Configurable command permissions
• [ ] Message history
  • [ ] Configurable cache contents
  • [x] Configurable cache life
• [ ] Karma
  • [X] Upvotes
  • [ ] Downvotes
• [x] Message queue
• [ ] Spam prevention
  • [ ] Configurable time and content limits
• [ ] Inactivity timeout
• [ ] CLI tools and utility scripts

Contributing

This project has a Trello board which you can use to see open tasks and progress.

If you would like to make a contribution, follow these steps:

1. Fork it (https://github.com/Charibdys/Private-Parlor/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Ensure that your code is documented and follows the Crystal API coding style.

Contributors

• Charybdis - creator and maintainer