Skip to content

Latest commit

 

History

History
99 lines (73 loc) · 4.58 KB

README.md

File metadata and controls

99 lines (73 loc) · 4.58 KB
Raw

Rotonde/client

Rotonde is a decentralized social network based on an equally decentralized application. The two parts of the application are as follows:

  • The client, the core of the application.
  • The portal, the user files, settings and customization.

The client, or Rotonde Core, is what contributors need to make improvements on the inner systems of the application. This separation allows for a simpler onboarding and updating flow, where the latest client revision will be seeded automatically (read-only), while the portal source is all that any simple user needs to maintain.

Setup

For a new user

  • Open @neauoire's portal in Beaker
    • dat://2f21e3c122ef0f2555d3a99497710cd875c7b0383f998a2d37c02c042d598485/
  • Select "Fork this site" and open it in your Library.
  • Select the input field and press ctrl shift del/backspace.
  • Share your user site hash with people, and paste theirs to follow them.
  • EXTRA If you already have an instance of the previous version of Rotonde, copy/paste your portal.json and move it into your site root.
  • Enjoy!

To make your portal reliable, add it to hashbase:

  • Go to https://hashbase.io
  • Create Account, then Upload Archive
  • For URL, enter the Dat url you created above
  • For Name, enter "rotonde"

This will give your portal a clean name, something like dat://rotonde-dcposch.hashbase.io

Hashbase will ensure that your portal stays available even when you're offline.

In case you're curious how these clean names work under the hood--they're references to opaque dat URLs. For example, Beaker resolves dat://daily-descent.hashbase.io/ by loading https://daily-descent.hashbase.io/.well-known/dat

For developers

That goal of this tutorial is to have both a local client and portal.

  • Clone both repositories in your ~/Sites
  • Create two sites using the Beaker Browser and point them to the user/client repositories.
  • Update the portal/index.html file with your client site hash, found in the Beaker address bar or the Share button.
  • Update the client/dat.json with the client site hash, and the portal/dat.json with the portal hash.
  • Enjoy!

Commands

  • dat://000 will follow a portal.
  • undat://000 will unfollow a portal.
  • filter word will show entries containing word.
  • filter:neauoire will show entries by ~neauoire.
  • clear_filter will clear the filtered feed.
  • edit:name alice will change your display name to ~alice.
  • edit:desc This is a brand new description will change your display description.
  • edit:site dat://google.com will change your display site, it can be any protocole(http,https).
  • edit:0 will edit your first entry.
  • delete:0 will delete your first entry.
  • quote:user_name-3 will quote another user's entry, where 3 is the entry ID 3.
  • quote:user_name-3 Have a look at this! will quote another user's entry, and add the entry Have a look at this!.
  • whisper:username Psst!
  • ++ will show the next page of entries
  • -- will show the previous page
  • page:5 will jump to page 5

Formatting

Style your messages using the following syntax

  • {*bold text*} bold text
  • {_italics_} italics
  • {-strikethrough text-} strikethrough text
  • {#code#} code
  • {descriptive links|https://github.com/Rotonde/rotonde-client} descriptive links

Runes

  • @ means you seed each other.
  • ~ means that they do not see you mention them.
  • & means that the message is a whisper.
  • $ means that they are a service or a bot.

Tabs

  • Entries shows the combined feeds of all followed portals.
  • Mentions shows entries that mention or quote you.
  • Whispers shows your whispers.
  • Portals shows a list of portals you follow.
  • Networks shows portals that are followed by the portals you follow.

Icon

To change your display icon, update the SVG file located at media/content/icon.svg. The icon should be a square file for it to display properly. Keep it small. If you update your SVG manually, don't forget to go to Library -> (Your Rotonde Site) and press Review Changes -> Publish, otherwise your changes wont be seen by anyone!

Rich content

  • TEXT >> MEDIA_NAME.jpg will connect a media filename from media/content/MEDIA_NAME.jpg.
  • TEXT {%CUSTOM_EMOJI%} TEXT will inline an image file from media/content/inline/CUSTOM_EMOJI.png.
  • suppoted media types are:
    image: gif, jpg, png, svg, webp
    video: ogv, webm, mp4
    audio: ogg, opus, mp3, m4a