# ABSTRACT: TUIs (full-screen Terminal UIs) for MUGS, including App and game UIs

unit module MUGS::UI::TUI:auth<zef:japhb>:ver<0.1.0>;

use Terminal::Print;
use Terminal::Print::DecodedInput;

use MUGS::Core;
use MUGS::Client;
use MUGS::UI;


# Base class for TUIs
class Game is MUGS::UI::Game {
    has $.T             = self.app-ui.T;
    has $.in            = decoded-input-supply;
    has $.ui-controller = Supplier.new;
    has $.ui-control    = $!ui-controller.Supply;


    method ui-type() { 'TUI' }
}




head

MUGS::UI::TUI - Fullscreen Terminal UI for MUGS, including App and game UIs


# Set up a full-stack MUGS-UI-TUI development environment
mkdir MUGS
cd MUGS
git clone git@github.com:Raku-MUGS/MUGS-Core.git
git clone git@github.com:Raku-MUGS/MUGS-Games.git
git clone git@github.com:Raku-MUGS/MUGS-UI-TUI.git


cd MUGS-Core
zef install --exclude="pq:ver<5>:from<native>" .
mugs-admin create-universe


cd ../MUGS-UI-TUI
zef install --deps-only .  # Or skip --deps-only if you prefer


# Play games using a local TUI UI, using an internal stub server and ephemeral data
mugs-tui


# Play games using an internal stub server accessing the long-lived data set
mugs-tui --universe=<universe-name>  # 'default' if set up as above


# Log in and play games on a WebSocket server using a local TUI UI
mugs-tui --server=<host>:<port>


# Start a TLS WebSocket game server on localhost:10000 using fake certs
mugs-ws-server


# Specify a different MUGS identity universe (defaults to "default")
mugs-ws-server --universe=other-universe


# Start a TLS WebSocket game server on different host:port
mugs-ws-server --host=<hostname> --port=<portnumber>


# Start a TLS WebSocket game server using custom certs
mugs-ws-server --private-key-file=<path> --certificate-file=<path>


# Write a Log::Timeline JSON log for the WebSocket server
LOG_TIMELINE_JSON_LINES=log/mugs-ws-server mugs-ws-server


B<NOTE: See the L<top-level MUGS repo|https://github.com/Raku-MUGS/MUGS> for more info.>


MUGS::UI::TUI is a TUI (Terminal UI) app (`mugs-tui`) and a growing set of UI
plugins to play games in
L<MUGS-Core|https://github.com/Raku-MUGS/MUGS-Core> and
L<MUGS-Games|https://github.com/Raku-MUGS/MUGS-Games> via the TUI.


B<This early version only contains very limited modules and plugins, is missing
significant functionality, and should not be considered "fully released" in the
same way that the CLI and WebSimple UIs are.>


MUGS is free software; you can redistribute it and/or modify it under the
Artistic License 2.0.


root

README

CONTRIBUTING

React

=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


=begin React :component<HeaderCol> :id<footer>  
=begin nested :!nested
=item1 B<Language>
    =item2 L<Get started|file:../getting-started/getting-started.podlite>
    =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
    =item2 L<Try Raku|https://glot.io/new/raku>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
    =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
    =item2 L<Language References|file:../doc/reference.podlite>
    =item2 L<Type Reference| file:../doc/types.podlite>
    =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
    =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
    =item2 L<Community|/doc/language/community>
    =item2 L<The list of all documents|file:../doc/index.podlite>

=item1 B<Resources>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>

=end nested
=begin nested :!nested

=item1 B<Resoures>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=item1 B<Learning>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
    =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
    =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
    =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
    =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
    =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
    =item2 L<Raku Advent Calendar|https://raku-advent.blog/>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=end React


=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React


TUI

NAME

SYNOPSIS

DESCRIPTION

AUTHOR

COPYRIGHT AND LICENSE

MUGS::UI::TUI v0.1.0

Authors

License

Dependencies

Test Dependencies

Provides

Documentation