Skip to content
This repository has been archived by the owner on Apr 30, 2021. It is now read-only.

wendyliga/mimiq

Repository files navigation

mimiq

mimiq

Build Status Twitter: @wendyliga

mimiq is simple executable to record your Xcode simulator and convert it to several video type like gif, mp4 or mov.

Sunsetting

on Xcode 12.5, Apple is supporting record mp4 and gif directly on Simulator GUI. hold Options, and screenshot button will swap into record.

Installation

Homebrew

if you don't have any idea about homebrew, homebrew is dependency manager on macos, to install homebrew

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

of for more information visit homebrew website

install via homebrew

brew install wendyliga/core/mimiq

Mint

# run without install
mint run wendyliga/mimiq

# or install
mint install wendyliga/mimiq

Manual Install

Clone Repo

git clone https://github.com/wendyliga/mimiq.git

execute build script

make install

you will get mimiq executable, use it as you want mimiq will installed at /usr/local/bin

GUI Version

mimiq-gui

Mimiq have a GUI version for Mac user, you can install and use it with keyboard shortcut and ease of click, check it more mimiq-gui.

How To Use

Start

instruction

mimiq

Just simple to call mimiq, it will automatically detect current running simulator and record it for you

Additional Options

🆕 Set Custom Output type

previously mimiq is focus on recording GIF from your simulator, but from feedback on early user of mimiq, it has big potential, not just GIF. so on 0.5.0, mimiq extend itself to support outputing format like mp4 and mov also.

available output

- gif
- mov
- mp4
mimiq --output mp4

🆕 Support Custom GIF Quality

you can specify what quality of GIF, mimiq will generate.

available quality

- low
- medium
- high

how to use

mimiq --quality high

Set custom Path

you can set where mimiq will place the generated output. for default, mimiq will generate output on desktop, but if you want to change it then, when start mimiq add this additional params

mimiq --path "~/...path/directory/folder"

Support Multiple Running Simulator

if you have multiple running simulator, then you need to spesify which simulator you want to mimiq.

get your running simulator by executing

mimiq list

example:

Screen Shot 2020-03-29 at 22 01 38

then record spesific simulato by its UDID

mimiq --udid 6ABC274C-76BB-483B-8DD6-8A9F8E486E0F

Stop

press `enter`

to stop, just press enter. then grab your generated output

Result

video

*raft approx 1Mb gif size for 15s

Upcomming Features

You can check upcomming feature on https://github.com/wendyliga/mimiq/projects/1

New version is available with this improvement, update your mimiq by

brew upgrade wendyliga/core/mimiq

LICENSE

MIT License

Copyright (c) 2020 Wendy Liga

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.