millipede

package module

v1.3.0 Latest Latest Go to latest Published: Apr 10, 2017 License: MIT Imports: 8 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/getmillipede/millipede-go

Links

Open Source Insights

README ¶

millipede-go 🐛

License

Golang version of getmillipede with some exclusive features.

Components

./: the millipede Golang API
./cmd/millipede-go: the millipede CLI
./cmd/millipede-web: the millipede web server
./cmd/millipede-fuse: the millipede file-system

CLI Usage

$ millipede-go -h
NAME:
   millipede-go - Print a beautiful millipede

USAGE:
   millipede-go [global options] command [command options] [arguments...]

VERSION:
   1.3.0-dev (HEAD)

AUTHOR(S):
   Millipede crew <https://github.com/getmillipede/millipede-go>

COMMANDS:
   help, h     Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --reverse, -r                           reverse the millipede
   --opposite, -o                          go the opposite direction
   --chameleon                             the millipede use its environment color
   --rainbow                               the millipede live with care bears
   --zalgo                                 invoke the hive-mind representing chaos
   --animate                               he is alive !
   --center, -C                            millipede in the midle
   --skin, --template, -s, -t "default"    millipede skin (default, frozen, love, corporate, musician, bocal, ascii, inception, humancentipede, finger)
   --width, -w "3"                         millipede width
   --curve, -c "4"                         millipede curve size
   --random                                RANDOMZ!
   --help, -h                              show help
   --version, -v                           print the version

Examples

$ millipede-go
    ╚⊙ ⊙╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝
    ╚═(███)═╝
    ╚═(███)═╝
   ╚═(███)═╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝
    ╚═(███)═╝
    ╚═(███)═╝
   ╚═(███)═╝
  ╚═(███)═╝
 ╚═(███)═╝

$ millipede-go 42
    ╚⊙ ⊙╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝
    ╚═(███)═╝
    ╚═(███)═╝
   ╚═(███)═╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝
    ╚═(███)═╝
    ╚═(███)═╝
   ╚═(███)═╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝
    ╚═(███)═╝
    ╚═(███)═╝
   ╚═(███)═╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝
    ╚═(███)═╝
    ╚═(███)═╝
   ╚═(███)═╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝

$ millipede-go --reverse
 ╔═(███)═╗
  ╔═(███)═╗
   ╔═(███)═╗
    ╔═(███)═╗
    ╔═(███)═╗
   ╔═(███)═╗
  ╔═(███)═╗
 ╔═(███)═╗
╔═(███)═╗
 ╔═(███)═╗
  ╔═(███)═╗
   ╔═(███)═╗
    ╔═(███)═╗
    ╔═(███)═╗
   ╔═(███)═╗
  ╔═(███)═╗
 ╔═(███)═╗
╔═(███)═╗
 ╔═(███)═╗
  ╔═(███)═╗
    ╔⊙ ⊙╗

$ millipede-go --opposite
    ╚⊙ ⊙╝
  ╚═(███)═╝
   ╚═(███)═╝
    ╚═(███)═╝
    ╚═(███)═╝
   ╚═(███)═╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝
    ╚═(███)═╝
    ╚═(███)═╝
   ╚═(███)═╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝

$ millipede-go --skin=bocal --opposite --reverse
   ╔═(🐟🐟🐟)═╗
  ╔═(🐟🐟🐟)═╗
 ╔═(🐟🐟🐟)═╗
╔═(🐟🐟🐟)═╗
 ╔═(🐟🐟🐟)═╗
  ╔═(🐟🐟🐟)═╗
   ╔═(🐟🐟🐟)═╗
    ╔═(🐟🐟🐟)═╗
    ╔═(🐟🐟🐟)═╗
   ╔═(🐟🐟🐟)═╗
  ╔═(🐟🐟🐟)═╗
 ╔═(🐟🐟🐟)═╗
╔═(🐟🐟🐟)═╗
 ╔═(🐟🐟🐟)═╗
  ╔═(🐟🐟🐟)═╗
   ╔═(🐟🐟🐟)═╗
    ╔═(🐟🐟🐟)═╗
    ╔═(🐟🐟🐟)═╗
   ╔═(🐟🐟🐟)═╗
  ╔═(🐟🐟🐟)═╗
    ╔⊙ ⊙╗

$ millipede-go --skin=ascii --width=7
    \o     o/
  |=(#######)=|
 |=(#######)=|
|=(#######)=|
 |=(#######)=|
  |=(#######)=|
   |=(#######)=|
    |=(#######)=|
    |=(#######)=|
   |=(#######)=|
  |=(#######)=|
 |=(#######)=|
|=(#######)=|
 |=(#######)=|
  |=(#######)=|
   |=(#######)=|
    |=(#######)=|
    |=(#######)=|
   |=(#######)=|
  |=(#######)=|
 |=(#######)=|

$ millipede-go --skin=bocal --curve=8 --opposite
          ╚⊙ ⊙╝
        ╚═(🐟🐟🐟)═╝
       ╚═(🐟🐟🐟)═╝
      ╚═(🐟🐟🐟)═╝
     ╚═(🐟🐟🐟)═╝
    ╚═(🐟🐟🐟)═╝
   ╚═(🐟🐟🐟)═╝
  ╚═(🐟🐟🐟)═╝
 ╚═(🐟🐟🐟)═╝
╚═(🐟🐟🐟)═╝
 ╚═(🐟🐟🐟)═╝
  ╚═(🐟🐟🐟)═╝
   ╚═(🐟🐟🐟)═╝
    ╚═(🐟🐟🐟)═╝
     ╚═(🐟🐟🐟)═╝
      ╚═(🐟🐟🐟)═╝
       ╚═(🐟🐟🐟)═╝
        ╚═(🐟🐟🐟)═╝
       ╚═(🐟🐟🐟)═╝
      ╚═(🐟🐟🐟)═╝
     ╚═(🐟🐟🐟)═╝

$ millipede-go --skin=bocal --curve=0
  ╚⊙ ⊙╝
╚═(🐟🐟🐟)═╝
╚═(🐟🐟🐟)═╝
╚═(🐟🐟🐟)═╝
╚═(🐟🐟🐟)═╝
╚═(🐟🐟🐟)═╝
╚═(🐟🐟🐟)═╝
╚═(🐟🐟🐟)═╝
╚═(🐟🐟🐟)═╝
╚═(🐟🐟🐟)═╝
╚═(🐟🐟🐟)═╝
╚═(🐟🐟🐟)═╝
╚═(🐟🐟🐟)═╝
╚═(🐟🐟🐟)═╝
╚═(🐟🐟🐟)═╝
╚═(🐟🐟🐟)═╝
╚═(🐟🐟🐟)═╝
╚═(🐟🐟🐟)═╝
╚═(🐟🐟🐟)═╝
╚═(🐟🐟🐟)═╝
╚═(🐟🐟🐟)═╝

$ millipede-go --zalgo
  ╚⊙̲͋ ⊙̴╝͇͠
╚═(̀█̴█̴█̨)̛̻═͜╝͍͡
 ╚̘═̶(ͪ́█̛ͯ█҉█͚́)̷̰═͙͜╝̴̦
  ╚̨═(͉͋█͘█͜█̲͘)̷═̢╝̴
   ╚═̯(̴█͢█҉█͟)͢═̫͝╝͏
    ╚͝═(̨█͜█̶█̜͠)̯̉́═̢╝̧͎͛
   ╚̩ͩ═̵(ͦ█̴█̡█̤͟)̧̟═̸͕̓╝̕
  ╚͟═̨(͟█̞͠█̕█́͢)̪ͪ͟═̡͎╝̸
 ╚═͞(█̴̚█̨̾█̓͜)͜═̴╝̡
╚̲═̨(█͠█҉̲█̴̮̓)̸̭═̕╝̴͎
 ╚͏═҉̬(̀█̛̬ͥ█̶͕█̷)͝═͈͠╝́
  ╚̵═(█̚͘█́█̴͚)̷̱═̶̺̎╝̛͉
   ╚═́(̙̀█̨█̢█ͧ͘)̵═̸╝҉
    ╚̛͉̔═̶̻(█̡͔█̓͘█̢͐)̡̜═͘╝̀
   ╚̷═̫(̞͗█̢͇█̴͉█̶̥)̷═̤̑͡╝̝̏͡
  ╚═͕(ͭ█̛█̸█̢͇)͞═͎͠╝͞
 ╚̧═̀(҉̙█̍͏█̟͘█͏)̵̫═̡̱╝̷
╚═̸(̉͟█̸█͝█̢)͟═̴͎╝̼̑͞
 ╚═(̂█̵͕█͏█̛)̧═̶̿╝̖̉͞
  ╚̡═̴ͦ(̦█̨█̶̥█҉)̛̮═͡╝̴
   ╚═(̨█͢█̨█̸)̡═̕╝̛̋

$ millipede-go --animate

$ millipede-go --animate --rainbow --curve=8 --width=5 --skin=humancentipede --chameleon 21

$ millipede-go --animate --zalgo

Web usage

$ millipede-web
2015/07/30 18:57:57 About to listen on 4242. Go to http://127.0.0.1:4242/

$ curl localhost:4242
  ╚⊙ ⊙╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝
    ╚═(███)═╝
   ╚═(███)═╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝
    ╚═(███)═╝
   ╚═(███)═╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝
$ curl localhost:4242/\?skin=bocal
╚⊙ ⊙╝
╚═(🐟🐟🐟)═╝
 ╚═(🐟🐟🐟)═╝
  ╚═(🐟🐟🐟)═╝
   ╚═(🐟🐟🐟)═╝
    ╚═(🐟🐟🐟)═╝
   ╚═(🐟🐟🐟)═╝
  ╚═(🐟🐟🐟)═╝
 ╚═(🐟🐟🐟)═╝
╚═(🐟🐟🐟)═╝
 ╚═(🐟🐟🐟)═╝
  ╚═(🐟🐟🐟)═╝
   ╚═(🐟🐟🐟)═╝
    ╚═(🐟🐟🐟)═╝
   ╚═(🐟🐟🐟)═╝
  ╚═(🐟🐟🐟)═╝
 ╚═(🐟🐟🐟)═╝
╚═(🐟🐟🐟)═╝
 ╚═(🐟🐟🐟)═╝
  ╚═(🐟🐟🐟)═╝
  ╚═(🐟🐟🐟)═╝

Install

Install using Golang

$ go get github.com/getmillipede/millipede-go/...

Install git version using homebrew

$ brew install getmillipede/millipede/millipede-go --HEAD

Install a released version using homebrew

$ brew install getmillipede/millipede/millipede-go

Download a statically compiled binary

Go to github.com/getmillipede/millipede-go/releases/latest

See all releases: https://github.com/getmillipede/millipede-go/releases

License

MIT

Documentation ¶

Rendered for

Overview ¶

Package millipede provides a framework for creating millipedes. millipede is designed to be easy to understand and write, the most simple application can be written as follow:

func main() {
  fmt.Println(millipede.New())
}

Index ¶

Constants
type Millipede
- func New() *Millipede
- func NewWithSize(size uint64) *Millipede
- func (m *Millipede) Draw() (string, error)
- func (m *Millipede) String() string
type Skin
type SkinCollection
- func (sc *SkinCollection) AddSkin(name string, skin Skin)
- func (sc *SkinCollection) GetByName(name string) (*Skin, error)
type SkinDirection

Constants ¶

View Source

const (
	DirectionUp = iota
	DirectionDown
	DirectionLeft
	DirectionRight
)

Direction constants

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Millipede ¶

type Millipede struct {
	// Size is the amount of feet pairs
	Size uint64
	// Reverse is the flag that indicates the direction (up/down)
	Reverse bool
	// Skin is the current millipede skin (template)
	Skin string
	// Opposite is the flag that indicates the direction (left/right)
	Opposite bool
	// Width is the width of the millipede (depending on its age and the food it consumes)
	Width uint64
	// Curve is the size of the curve
	Curve uint64
	// Chameleon is the flag that indicates the millipede share its environment color
	Chameleon bool
	// Rainbow is the flag that indicates the millipede live with care bears
	Rainbow bool
	// Zalgo is the flag that invoke the hive-mind representing chaos
	Zalgo bool
	// Step is the amount of steps done by the millipede (useful for animations)
	Steps uint64
	// Center is the flag that centers the millipede in the middle of the screen
	Center bool

	// PadRight is the flag that indicates the need to add spacing on the right of the output
	PadRight bool
	// contains filtered or unexported fields
}

Millipede defines a millipede configuration

Example ¶

millipede := &Millipede{
	Size:      20,
	Reverse:   false,
	Skin:      "default",
	Opposite:  false,
	Width:     3,
	Curve:     4,
	Chameleon: false,
	Rainbow:   false,
	Zalgo:     false,
	Steps:     0,
}
fmt.Printf("%s\n", millipede)

Output:

  ╚⊙ ⊙╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝
    ╚═(███)═╝
   ╚═(███)═╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝
    ╚═(███)═╝
   ╚═(███)═╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝

func New ¶

func New() *Millipede

New returns a millipede with default values

Example ¶

millipede := New()
fmt.Println(millipede)

Output:

  ╚⊙ ⊙╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝
    ╚═(███)═╝
   ╚═(███)═╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝
    ╚═(███)═╝
   ╚═(███)═╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝

func NewWithSize ¶ added in v1.3.0

func NewWithSize(size uint64) *Millipede

NewWithSize returns a millipede with default values but a custom size

Example ¶

millipede := NewWithSize(20)
fmt.Println(millipede)

Output:

  ╚⊙ ⊙╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝
    ╚═(███)═╝
   ╚═(███)═╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝
    ╚═(███)═╝
   ╚═(███)═╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝

func (*Millipede) Draw ¶ added in v1.3.0

func (m *Millipede) Draw() (string, error)

Draw returns a string representing a millipede and an error if any

func (*Millipede) String ¶

func (m *Millipede) String() string

String returns a string representing a millipede and an empty string if an error occured

Example ¶

millipede := NewWithSize(20)
fmt.Println(millipede)

Output:

  ╚⊙ ⊙╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝
    ╚═(███)═╝
   ╚═(███)═╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝
    ╚═(███)═╝
   ╚═(███)═╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝

Example (Center) ¶

millipede := NewWithSize(20)
millipede.Center = true

// FIXME: if possible make a better test

output := fmt.Sprint(millipede)
fmt.Println(output)

Output:

  ╚⊙ ⊙╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝
    ╚═(███)═╝
   ╚═(███)═╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝
    ╚═(███)═╝
   ╚═(███)═╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝

Example (Chameleon) ¶

millipede := NewWithSize(20)
millipede.Chameleon = true

fmt.Println(millipede)

Output:

  �[30m╚⊙ ⊙╝�[0m
�[30m╚═(███)═╝�[0m
 �[30m╚═(███)═╝�[0m
  �[30m╚═(███)═╝�[0m
   �[30m╚═(███)═╝�[0m
    �[30m╚═(███)═╝�[0m
   �[30m╚═(███)═╝�[0m
  �[30m╚═(███)═╝�[0m
 �[30m╚═(███)═╝�[0m
�[30m╚═(███)═╝�[0m
 �[30m╚═(███)═╝�[0m
  �[30m╚═(███)═╝�[0m
   �[30m╚═(███)═╝�[0m
    �[30m╚═(███)═╝�[0m
   �[30m╚═(███)═╝�[0m
  �[30m╚═(███)═╝�[0m
 �[30m╚═(███)═╝�[0m
�[30m╚═(███)═╝�[0m
 �[30m╚═(███)═╝�[0m
  �[30m╚═(███)═╝�[0m
   �[30m╚═(███)═╝�[0m

Example (Chameleon_rainbow) ¶

millipede := NewWithSize(20)
millipede.Chameleon = true
millipede.Rainbow = true

fmt.Println(millipede)

Output:

  �[30;41m╚⊙ ⊙╝�[0m
�[30;42m╚═(███)═╝�[0m
 �[30;43m╚═(███)═╝�[0m
  �[30;44m╚═(███)═╝�[0m
   �[30;45m╚═(███)═╝�[0m
    �[30;46m╚═(███)═╝�[0m
   �[30;47m╚═(███)═╝�[0m
  �[30;41m╚═(███)═╝�[0m
 �[30;42m╚═(███)═╝�[0m
�[30;43m╚═(███)═╝�[0m
 �[30;44m╚═(███)═╝�[0m
  �[30;45m╚═(███)═╝�[0m
   �[30;46m╚═(███)═╝�[0m
    �[30;47m╚═(███)═╝�[0m
   �[30;41m╚═(███)═╝�[0m
  �[30;42m╚═(███)═╝�[0m
 �[30;43m╚═(███)═╝�[0m
�[30;44m╚═(███)═╝�[0m
 �[30;45m╚═(███)═╝�[0m
  �[30;46m╚═(███)═╝�[0m
   �[30;47m╚═(███)═╝�[0m

Example (Complex) ¶

millipede := NewWithSize(20)
millipede.Size = 42
millipede.Reverse = true
millipede.Skin = "bocal"
millipede.Opposite = true
millipede.Width = 12
millipede.Curve = 10

fmt.Println(millipede)

Output:

         ╔═(🐟🐟🐟🐟🐟🐟)═╗
          ╔═(🐟🐟🐟🐟🐟🐟)═╗
         ╔═(🐟🐟🐟🐟🐟🐟)═╗
        ╔═(🐟🐟🐟🐟🐟🐟)═╗
       ╔═(🐟🐟🐟🐟🐟🐟)═╗
      ╔═(🐟🐟🐟🐟🐟🐟)═╗
     ╔═(🐟🐟🐟🐟🐟🐟)═╗
    ╔═(🐟🐟🐟🐟🐟🐟)═╗
   ╔═(🐟🐟🐟🐟🐟🐟)═╗
  ╔═(🐟🐟🐟🐟🐟🐟)═╗
 ╔═(🐟🐟🐟🐟🐟🐟)═╗
╔═(🐟🐟🐟🐟🐟🐟)═╗
 ╔═(🐟🐟🐟🐟🐟🐟)═╗
  ╔═(🐟🐟🐟🐟🐟🐟)═╗
   ╔═(🐟🐟🐟🐟🐟🐟)═╗
    ╔═(🐟🐟🐟🐟🐟🐟)═╗
     ╔═(🐟🐟🐟🐟🐟🐟)═╗
      ╔═(🐟🐟🐟🐟🐟🐟)═╗
       ╔═(🐟🐟🐟🐟🐟🐟)═╗
        ╔═(🐟🐟🐟🐟🐟🐟)═╗
         ╔═(🐟🐟🐟🐟🐟🐟)═╗
          ╔═(🐟🐟🐟🐟🐟🐟)═╗
         ╔═(🐟🐟🐟🐟🐟🐟)═╗
        ╔═(🐟🐟🐟🐟🐟🐟)═╗
       ╔═(🐟🐟🐟🐟🐟🐟)═╗
      ╔═(🐟🐟🐟🐟🐟🐟)═╗
     ╔═(🐟🐟🐟🐟🐟🐟)═╗
    ╔═(🐟🐟🐟🐟🐟🐟)═╗
   ╔═(🐟🐟🐟🐟🐟🐟)═╗
  ╔═(🐟🐟🐟🐟🐟🐟)═╗
 ╔═(🐟🐟🐟🐟🐟🐟)═╗
╔═(🐟🐟🐟🐟🐟🐟)═╗
 ╔═(🐟🐟🐟🐟🐟🐟)═╗
  ╔═(🐟🐟🐟🐟🐟🐟)═╗
   ╔═(🐟🐟🐟🐟🐟🐟)═╗
    ╔═(🐟🐟🐟🐟🐟🐟)═╗
     ╔═(🐟🐟🐟🐟🐟🐟)═╗
      ╔═(🐟🐟🐟🐟🐟🐟)═╗
       ╔═(🐟🐟🐟🐟🐟🐟)═╗
        ╔═(🐟🐟🐟🐟🐟🐟)═╗
         ╔═(🐟🐟🐟🐟🐟🐟)═╗
          ╔═(🐟🐟🐟🐟🐟🐟)═╗
            ╔⊙    ⊙╗

Example (Curve) ¶

millipede := NewWithSize(20)
millipede.Curve = 6

fmt.Println(millipede)

Output:

  ╚⊙ ⊙╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝
    ╚═(███)═╝
     ╚═(███)═╝
      ╚═(███)═╝
     ╚═(███)═╝
    ╚═(███)═╝
   ╚═(███)═╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝
    ╚═(███)═╝
     ╚═(███)═╝
      ╚═(███)═╝
     ╚═(███)═╝

Example (Curve_zero) ¶

millipede := NewWithSize(20)
millipede.Curve = 0

fmt.Println(millipede)

Output:

  ╚⊙ ⊙╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝

Example (Multiplepede) ¶

millipede := New()
millipede.Skin = "diagonals"
fmt.Println(millipede)

Output:

  ╚⊙ ⊙╝
\/(███)\/
 /\(███)/\
  \/(███)\/
   /\(███)/\
    \/(███)\/
   /\(███)/\
  \/(███)\/
 /\(███)/\
\/(███)\/
 /\(███)/\
  \/(███)\/
   /\(███)/\
    \/(███)\/
   /\(███)/\
  \/(███)\/
 /\(███)/\
\/(███)\/
 /\(███)/\
  \/(███)\/
   /\(███)/\

Example (Opposite) ¶

millipede := NewWithSize(20)
millipede.Opposite = true

fmt.Println(millipede)

Output:

      ╚⊙ ⊙╝
    ╚═(███)═╝
   ╚═(███)═╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝
    ╚═(███)═╝
   ╚═(███)═╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝
    ╚═(███)═╝
   ╚═(███)═╝
  ╚═(███)═╝
 ╚═(███)═╝

Example (Rainbow) ¶

millipede := NewWithSize(20)
millipede.Rainbow = true

fmt.Println(millipede)

Output:

  �[30;41m╚⊙ ⊙╝�[0m
�[30;42m╚═(███)═╝�[0m
 �[30;43m╚═(███)═╝�[0m
  �[30;44m╚═(███)═╝�[0m
   �[30;45m╚═(███)═╝�[0m
    �[30;46m╚═(███)═╝�[0m
   �[30;47m╚═(███)═╝�[0m
  �[30;41m╚═(███)═╝�[0m
 �[30;42m╚═(███)═╝�[0m
�[30;43m╚═(███)═╝�[0m
 �[30;44m╚═(███)═╝�[0m
  �[30;45m╚═(███)═╝�[0m
   �[30;46m╚═(███)═╝�[0m
    �[30;47m╚═(███)═╝�[0m
   �[30;41m╚═(███)═╝�[0m
  �[30;42m╚═(███)═╝�[0m
 �[30;43m╚═(███)═╝�[0m
�[30;44m╚═(███)═╝�[0m
 �[30;45m╚═(███)═╝�[0m
  �[30;46m╚═(███)═╝�[0m
   �[30;47m╚═(███)═╝�[0m

Example (Reverse) ¶

millipede := NewWithSize(20)
millipede.Reverse = true

fmt.Println(millipede)

Output:

   ╔═(███)═╗
  ╔═(███)═╗
 ╔═(███)═╗
╔═(███)═╗
 ╔═(███)═╗
  ╔═(███)═╗
   ╔═(███)═╗
    ╔═(███)═╗
   ╔═(███)═╗
  ╔═(███)═╗
 ╔═(███)═╗
╔═(███)═╗
 ╔═(███)═╗
  ╔═(███)═╗
   ╔═(███)═╗
    ╔═(███)═╗
   ╔═(███)═╗
  ╔═(███)═╗
 ╔═(███)═╗
╔═(███)═╗
  ╔⊙ ⊙╗

Example (Skin) ¶

millipede := NewWithSize(20)
millipede.Skin = "bocal"

fmt.Println(millipede)

Output:

  ╚⊙ ⊙╝
╚═(🐟🐟🐟)═╝
 ╚═(🐟🐟🐟)═╝
  ╚═(🐟🐟🐟)═╝
   ╚═(🐟🐟🐟)═╝
    ╚═(🐟🐟🐟)═╝
   ╚═(🐟🐟🐟)═╝
  ╚═(🐟🐟🐟)═╝
 ╚═(🐟🐟🐟)═╝
╚═(🐟🐟🐟)═╝
 ╚═(🐟🐟🐟)═╝
  ╚═(🐟🐟🐟)═╝
   ╚═(🐟🐟🐟)═╝
    ╚═(🐟🐟🐟)═╝
   ╚═(🐟🐟🐟)═╝
  ╚═(🐟🐟🐟)═╝
 ╚═(🐟🐟🐟)═╝
╚═(🐟🐟🐟)═╝
 ╚═(🐟🐟🐟)═╝
  ╚═(🐟🐟🐟)═╝
   ╚═(🐟🐟🐟)═╝

Example (Tail) ¶

millipede := New()
millipede.Skin = "frozen"
fmt.Println(millipede)

Output:

  ╚⊙ ⊙╝
╚═(❄❄❄)═╝
 ╚═(❄❄❄)═╝
  ╚═(❄❄❄)═╝
   ╚═(❄❄❄)═╝
    ╚═(❄❄❄)═╝
   ╚═(❄❄❄)═╝
  ╚═(❄❄❄)═╝
 ╚═(❄❄❄)═╝
╚═(❄❄❄)═╝
 ╚═(❄❄❄)═╝
  ╚═(❄❄❄)═╝
   ╚═(❄❄❄)═╝
    ╚═(❄❄❄)═╝
   ╚═(❄❄❄)═╝
  ╚═(❄❄❄)═╝
 ╚═(❄❄❄)═╝
╚═(❄❄❄)═╝
 ╚═(❄❄❄)═╝
  ╚═(❄❄❄)═╝
   ╚═(❄❄❄)═╝
       ❄

Example (Width10) ¶

millipede := NewWithSize(20)
millipede.Width = 10

fmt.Println(millipede)

Output:

  ╚⊙  ⊙╝
╚═(████)═╝
 ╚═(████)═╝
  ╚═(████)═╝
   ╚═(████)═╝
    ╚═(████)═╝
   ╚═(████)═╝
  ╚═(████)═╝
 ╚═(████)═╝
╚═(████)═╝
 ╚═(████)═╝
  ╚═(████)═╝
   ╚═(████)═╝
    ╚═(████)═╝
   ╚═(████)═╝
  ╚═(████)═╝
 ╚═(████)═╝
╚═(████)═╝
 ╚═(████)═╝
  ╚═(████)═╝
   ╚═(████)═╝

Example (Width12) ¶

millipede := NewWithSize(20)
millipede.Width = 12

fmt.Println(millipede)

Output:

  ╚⊙    ⊙╝
╚═(██████)═╝
 ╚═(██████)═╝
  ╚═(██████)═╝
   ╚═(██████)═╝
    ╚═(██████)═╝
   ╚═(██████)═╝
  ╚═(██████)═╝
 ╚═(██████)═╝
╚═(██████)═╝
 ╚═(██████)═╝
  ╚═(██████)═╝
   ╚═(██████)═╝
    ╚═(██████)═╝
   ╚═(██████)═╝
  ╚═(██████)═╝
 ╚═(██████)═╝
╚═(██████)═╝
 ╚═(██████)═╝
  ╚═(██████)═╝
   ╚═(██████)═╝

Example (Width3) ¶

millipede := NewWithSize(20)
millipede.Width = 3

fmt.Println(millipede)

Output:

  ╚⊙ ⊙╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝
    ╚═(███)═╝
   ╚═(███)═╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝
    ╚═(███)═╝
   ╚═(███)═╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝

Example (Width9) ¶

millipede := NewWithSize(20)
millipede.Width = 9

fmt.Println(millipede)

Output:

  ╚⊙ ⊙╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝
    ╚═(███)═╝
   ╚═(███)═╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝
    ╚═(███)═╝
   ╚═(███)═╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝

type Skin ¶

type Skin struct {
	Up   *SkinDirection
	Down *SkinDirection
	// contains filtered or unexported fields
}

Skin defines the different parts of a millipede body

func (*Skin) GetHead ¶ added in v1.3.0

func (s *Skin) GetHead() string

GetHead returns a the head of the millipede

func (*Skin) GetPede ¶ added in v1.3.0

func (s *Skin) GetPede(i int) string

GetPede returns the pede of the millipede

func (*Skin) GetTail ¶ added in v1.3.0

func (s *Skin) GetTail() string

GetTail returns a the tail of the millipede

func (*Skin) NextPede ¶ added in v1.3.0

func (s *Skin) NextPede() string

NextPede returns GetPede with an incremental i

func (*Skin) SetDirection ¶ added in v1.3.0

func (s *Skin) SetDirection(newDirection int) error

SetDirection sets the current direction of the skin

func (*Skin) SetWidth ¶ added in v1.3.0

func (s *Skin) SetWidth(width int) error

SetWidth set wanted width

func (*Skin) Width ¶ added in v1.3.0

func (s *Skin) Width() int

Width returns the max width of any element

type SkinCollection ¶ added in v1.3.0

type SkinCollection struct {
	// contains filtered or unexported fields
}

SkinCollection represents a collection of skins

var Skins SkinCollection

Skins is the global collection of registered skins

func (*SkinCollection) AddSkin ¶ added in v1.3.0

func (sc *SkinCollection) AddSkin(name string, skin Skin)

func (*SkinCollection) GetByName ¶ added in v1.3.0

func (sc *SkinCollection) GetByName(name string) (*Skin, error)

GetByName returns a skin based on its name or an error

type SkinDirection ¶ added in v1.3.0

type SkinDirection struct {
	// Head is used by the millipede to think about its life
	Head string
	// Pede are what make this arthropod so special
	Pede []string

	// Tail is what make a millipede looking like a snake
	Tail string
}

SkinDirection defines a skin for a direction (up, down, left, right)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
millipede-fuse Millipedefs implements a "millipede" file system.	Millipedefs implements a "millipede" file system.
millipede-go NAME: millipede-go - Print a beautiful millipede USAGE: millipede-go [global options] command [command options] [arguments...] VERSION: 1.3.0-dev (HEAD) AUTHOR(S): Millipede crew <https://github.com/getmillipede/millipede-go> COMMANDS: help, hShows a list of commands or help for one command GLOBAL OPTIONS: --reverse, -rreverse the millipede --opposite, -ogo the opposite direction --chameleonthe millipede use its environment color --rainbowthe millipede live with care bears --zalgoinvoke the hive-mind representing chaos --animatehe is alive ! --center, -Cmillipede in the midle --skin, --template, -s, -t "default"millipede skin (default, frozen, love, corporate, musician, bocal, ascii, inception, humancentipede, finger) --width, -w "3"millipede width --curve, -c "4"millipede curve size --steps "0"amount of steps done by the millipede --help, -hshow help --version, -vprint the version	NAME: millipede-go - Print a beautiful millipede USAGE: millipede-go [global options] command [command options] [arguments...] VERSION: 1.3.0-dev (HEAD) AUTHOR(S): Millipede crew <https://github.com/getmillipede/millipede-go> COMMANDS: help, hShows a list of commands or help for one command GLOBAL OPTIONS: --reverse, -rreverse the millipede --opposite, -ogo the opposite direction --chameleonthe millipede use its environment color --rainbowthe millipede live with care bears --zalgoinvoke the hive-mind representing chaos --animatehe is alive ! --center, -Cmillipede in the midle --skin, --template, -s, -t "default"millipede skin (default, frozen, love, corporate, musician, bocal, ascii, inception, humancentipede, finger) --width, -w "3"millipede width --curve, -c "4"millipede curve size --steps "0"amount of steps done by the millipede --help, -hshow help --version, -vprint the version
millipede-http
version

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

README ¶

millipede-go 🐛

Components

CLI Usage

Examples

Web usage

Install

License

Documentation ¶

Overview ¶

Index ¶

Examples ¶

Constants ¶

Variables ¶

Functions ¶

Types ¶

type Millipede ¶

func New ¶

func NewWithSize ¶ added in v1.3.0

func (*Millipede) Draw ¶ added in v1.3.0

func (*Millipede) String ¶

type Skin ¶

func (*Skin) GetHead ¶ added in v1.3.0

func (*Skin) GetPede ¶ added in v1.3.0

func (*Skin) GetTail ¶ added in v1.3.0

func (*Skin) NextPede ¶ added in v1.3.0

func (*Skin) SetDirection ¶ added in v1.3.0

func (*Skin) SetWidth ¶ added in v1.3.0

func (*Skin) Width ¶ added in v1.3.0

type SkinCollection ¶ added in v1.3.0

func (*SkinCollection) AddSkin ¶ added in v1.3.0

func (*SkinCollection) GetByName ¶ added in v1.3.0

type SkinDirection ¶ added in v1.3.0

Source Files ¶

Directories ¶