Middleman -botit

Middleman on bottiohjelmisto, jota Elokapina käyttää Elementissä tarvittavien yhteistunnusten hallinnointiin. Lyhykäisyydessään, Middleman toimii nimensä mukaisesti välikätenä niiden välillä, jotka ovat yhteiskäyttötunnukseen yhteydessä ja niiden välillä, jotka hallinnoivat kyseistä yhteiskäyttötunnusta. Middleman botin voi linkittää mihin tahansa Element tunnukseen.

Miten Middleman toimii?

Jokainen Middleman asennus liitetään johonkin olemassaolevaan Element tunnukseen. Jokaiselle luodaan myös ns komentohuone, jonka jäsenet käyttävät Middlemanin kautta kyseistä tunnusta.

Viestit, jotka Middleman botti vastaanottaa, tulevat botin kirjoittamana komentohuoneeseen. Viesti voi olla yksityisviesti, viesti isommassa huoneessa tai maininta. Saadut viestit botti välittää sellaisenaan komentohuoneeseen (HUOM: kuvat eivät vielä toimi).

Middleman asennuksesta riippuen lähettäjän nimi voidaan tarvittaessa jättää viestistä pois, joka mahdollistaa yhteiskäyttötunnuksen toimimisen anonyyminä palautekanavana (huomiona kuitenkin, että infra, joka hallinnoi tunnuksia, näkee lähettäjät, tarvittaessa - täysin anonyymeja palautekanavia ei Elementin kautta voida toteuttaa).

Middleman voidaan myös asentaa niin, että ollessaan isommassa huoneessa, vain maininnat lähetetään komentohuoneeseen. Tämä mahdollistaa yhteiskäyttötunnuksen olemisen esimerkiksi kansallisessa olohuoneessa, ilman että komentohuoneeseen valuu muita kuin yhteiskäyttötunnusta koskevia viestejä.

Komentohuone

Kun yhteiskäyttötunnus saa viestejä, ne tulevat komentohuoneeseen esim seuraavanlaisena:

@kapinallinen:elokapina.fi in !UytdstrhskHYStsddf:elokapina.fi: Hei yhteiskäyttötunnus!

Viesti kertoo: lähettäjän (ellei anonymisoitu), huoneen ID:n (teknistä tietoa) ja viestin tekstin. Kaikki viestit, jotka yhteiskäyttötunnukselle kohdistetaan, päätyvät samaan komentohuoneeseen.

Komentohuoneessa olevat voivat keskustella vapaasti, ilman että Middleman välittää viestejä takaisin.

Kun johonkin viestiin halutaan vastata, tulee käyttää Elementin reply / vastaa toimintoa ja aloittaa vastaus tekstillä !reply . Ilman tätä viesti ei lähde takaisin vastaanottajalle. Esimerkkinä vastaus ylläolevaan:

> @kapinallinen:elokapina.fi in !UytdstrhskHYStsddf:elokapina.fi: Hei yhteiskäyttötunnus!

!reply Hei kapinallinen!

Middleman botti vastaa ymmärtäneensä tämän komennon seuraavasti:

Message delivered back to the sender in room !UytdstrhskHYStsddf:elokapina.fi.

Viesti lähtee aina takaisin siihen huoneeseen, josta se on saapunut. Näin useita yksityiskeskusteluja tai huonekeskusteluja voidaan hallinnoida yhdestä komentohuoneesta.

Komentohuoneesta voi myös kirjoittaa viestejä ulospäin kaikkiin huoneisiin, joissa botti majailee. Tällöin syntaksi on seuraava:

!message #middleman:elokapina.fi Hei Middleman fanit!

Tämä lähettäisi viestin "Hei Middleman fanit!" huoneeseen #middleman:elokapina.fi. Huoneen voi myös antaa ID muodossa eli !UytdstrhskHYStsddf:elokapina.fi esimerkiksi.

Vastaanottaja ei näe kuka komentohuoneessa on kyseisen viestin kirjoittanut. Viesti näyttää vastaanottajalle normaalilta Element viestiltä.

Kuka voi vastata viesteihin komentohuoneessa?

Kuka tahansa komentohuoneen jäsen, jolla on oikeus kirjoittaa viestejä huoneeseen, voi vastata niihin.

Mitä tapahtuu, kun joku avaa yksityisviestin yhteiskäyttötunnuksen kanssa, johon on linkitetty Middleman botti?

Keskustelun avaajalle kokemus on muuten aivan sama kuin minkä tahansa muun tunnuksen kanssa, paitsi että Middleman botti lähettää asennuksesta riippuen tervetuloviestin. Tässä viestissä voi kertoa esimerkiksi mitä toiveita yhteiskäyttötunnuksen ylläpitäjillä on yhteydenoton suhteen tai esimerkiksi kertoa, että kuvat eivät vielä toimi :)

Tervetuloviestiä voi muokata haluamakseen tai poistaa.

Miten saan oman Middleman botin yhteiskäyttötunnukselleni?

Ota yhteys infraan, esimerkiksi infran omaan Middleman botin kautta toimivaan yhteiskäyttötunnukseen, @xryllapito:elokapina.fi. Pyydä yhteiskäyttötunnusta Middleman botilla.

Ryhmällämme on jo tunnus, mutta haluaisimme linkittää sen Middleman bottiin

Tämä onnistuu, infra voi linkittää Middleman botin tunnukseen

Voinko käyttää normaalia Element ohjelmaa yhteiskäyttötunnuksellani, vaikka siihen on linkitetty Middleman botti?

Kyllä voit. Salauksen vuoksi, Middleman botin sessio ja Element sessiot eivät välttämättä näe toistensa viestejä, mutta molempien pitäisi nähdä kyllä lähettäjien viestit.

Tekniikka kiinnostaa ja/tai haluan auttaa lisäominaisuuksien suhteen

Yay! Botin koodi löytyy GitHubista. Lisäominaisuuksia / korjauksia otetaan mielellään vastaan.