Skip to content

Commit b540cdd

Browse files
KFERMercerKFERMercer
committed
README.md: improve layout
1 parent 37cc467 commit b540cdd

File tree

1 file changed

+79
-39
lines changed

1 file changed

+79
-39
lines changed

‎README.md‎

Lines changed: 79 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -2,62 +2,96 @@
22

33
<div align="center"><p>Chaturbate-Grabber/CtbCap is a Functional, Reliable, Easy to Use, yet Extremely Lightweight <strong>Recorder</strong>/<strong>Watchbot</strong> for Chaturbate|StripChat.</p></div>
44

5-
<div align="center"><p><strong><a href="#official-ctbcap-container-registry">Official Container Registry</a></strong></p></div>
6-
75
<div align="center"><h2>Key Advantages</h2></div>
86

9-
- **Lightweight** - Written by most basic Shell Scripts with full POSIX compatibility. [Pythonless](https://m.media-amazon.com/images/I/71CmeuB3XXL._AC_UF1000,1000_QL80_.jpg), but far superior performance and energy efficiency.
7+
- **Lightweight** - Written in most basic Shell Scripts to strive POSIX compatibility and energy efficiency.
8+
> Py is so braindead.
109
1110
- **All platforms available** - All functions are available with just require `curl` & `ffmpeg`.
12-
13-
> Considering all the things mentioned and their platform versatility, this pretty much means you can run it on any device with only need internet connection: your phone, refrigerator, slipper, TV remote, [buttplug](https://news.berkeley.edu/wp-content/uploads/2017/10/SaguaroCardon750.jpg), even [your boss's wig](https://m.media-amazon.com/images/I/71+B81wFylL._SX466_.jpg).
11+
> $0.1 Temu Phone? No problem.
1412
1513
- **Multifunction** - Auto Recording; Auto Monitoring; Auto Stopping; Large-Scale Deployment... Just find by yourself.
14+
> I'm lighter, yet I'm more powerful.
1615
1716
<div align="center"><h2>Usage | Deploy</h2></div>
1817

1918
### **Launch with One-Command:**
2019

21-
> Yeah, 1 Line, Just Crazy.
20+
**Open your whatever terminal & drop this:**
2221

23-
> **Termux is Supported.**
22+
```shell
23+
sh -c "$(curl -sL https://raw.githubusercontent.com/KFERMercer/chaturbate-grabber/master/ctbcap)" @ -h
24+
```
2425

25-
- Open your whatever terminal & drop this:
26+
> [!NOTE]
27+
> Put the options after `@` . e.g:\
28+
> `sh -c <...curl...stuff...> @ -ef ~/rec your_mom`
2629
27-
```shell
28-
sh -c "$(curl -sL https://raw.githubusercontent.com/KFERMercer/chaturbate-grabber/master/ctbcap)" @ -h
29-
```
30-
> Put the options after `@` . e.g:\
31-
> `sh -c <...curl...stuff...> @ -ef ~/rec your_mom`
30+
> [!TIP]
31+
> You can also choose to download/upgrade CtbCap to your local:\
32+
> `curl -L https://raw.githubusercontent.com/KFERMercer/chaturbate-grabber/master/ctbcap -o ctbcap && chmod +x ctbcap`\
33+
> After its done, run `./ctbcap` to launch CtbCap.
3234
33-
> You can also choose to download | upgrade CtbCap to your local:\
34-
> `curl -L https://raw.githubusercontent.com/KFERMercer/chaturbate-grabber/master/ctbcap -o ctbcap && chmod +x ctbcap`\
35-
> After its done, run `./ctbcap` to launch CtbCap.
35+
> [!TIP]
36+
> **Termux is Supported.**
3637
3738
##
3839

3940
### **Docker Container (Recommend) :**
4041

42+
> [!NOTE]
4143
> If you're using such platforms that have good support for Docker or similar, I highly recommend to use this method: More serious; High-Availability; Everything runs in containers; Easily configures lot of chatrooms at the same time.
4244
4345
#### **Official CtbCap Container Registry:**
4446

45-
- [Docker Hub](https://hub.docker.com/r/kfermercer/ctbcap): `docker pull kfermercer/ctbcap:latest`
46-
47-
- [GitHub Package](https://github.com/KFERMercer/chaturbate-grabber/pkgs/container/ctbcap): `docker pull ghcr.io/kfermercer/ctbcap:latest`
48-
49-
| Platform | Available |
50-
| :-: | :-: |
51-
| x86 | ✅ |
52-
| x86_64 | ✅ |
53-
| armhf | ✅ |
54-
| armv7 | ✅ |
55-
| aarch64 | ✅ |
56-
| loongarch64 | ✅ |
57-
| ppc64le | ✅ |
58-
| riscv64 | ✅ |
59-
| s390x | ✅ |
60-
> **CtbCap will always deliver on the [Compatibility Promise](https://news.berkeley.edu/wp-content/uploads/2017/10/SaguaroCardon750.jpg).**
47+
- [Docker Hub](https://hub.docker.com/r/kfermercer/ctbcap): `docker pull kfermercer/ctbcap:latest`
48+
49+
- [GitHub Package](https://github.com/KFERMercer/chaturbate-grabber/pkgs/container/ctbcap): `docker pull ghcr.io/kfermercer/ctbcap:latest`
50+
51+
<table>
52+
<tr align="center">
53+
<th>Platform</th>
54+
<th>Available</th>
55+
<th>Status</th>
56+
</tr>
57+
<tr align="center">
58+
<td>x86</td>
59+
<td>✅</td>
60+
<td rowspan="0"><a href="https://github.com/KFERMercer/chaturbate-grabber/actions/workflows/Build-Push-Containers.yml"><img src="https://img.shields.io/github/actions/workflow/status/KFERMercer/chaturbate-grabber/Build-Push-Containers.yml"></a></td>
61+
</tr>
62+
<tr align="center">
63+
<td>x86_64</td>
64+
<td>✅</td>
65+
</tr>
66+
<tr align="center">
67+
<td>armhf</td>
68+
<td>✅</td>
69+
</tr>
70+
<tr align="center">
71+
<td>armv7</td>
72+
<td>✅</td>
73+
</tr>
74+
<tr align="center">
75+
<td>aarch64</td>
76+
<td>✅</td>
77+
</tr>
78+
<tr align="center">
79+
<td>loongarch64</td>
80+
<td>✅</td>
81+
</tr>
82+
<tr align="center">
83+
<td>ppc64le</td>
84+
<td>✅</td>
85+
</tr>
86+
<tr align="center">
87+
<td>riscv64</td>
88+
<td>✅</td>
89+
</tr>
90+
<tr align="center">
91+
<td>s390x</td>
92+
<td>✅</td>
93+
</tr>
94+
</table>
6195

6296
#### **Run As Compose Daemon (Recommend)** :
6397

@@ -66,6 +100,7 @@
66100
```shell
67101
curl -L https://raw.githubusercontent.com/KFERMercer/chaturbate-grabber/master/docker-compose.sample.yml -o ctbcap-compose.yml
68102
```
103+
69104
Then edit `./ctbcap-compose.yml` to configure.
70105

71106
2. Deploy the compose daemon:
@@ -89,23 +124,28 @@ docker run -t --rm \
89124
-v </path/to/recdir>:/save \
90125
-v </path/to/logdir>:/log \
91126
-e TZ=Asia/Shanghai \
92-
-e <ARG>=<value> \
127+
-e <VAR>=<value> \
93128
... \
94129
kfermercer/ctbcap -h
95130
```
96131

97-
> Option `-u <UID>:<GID>` allows you to specify the user (UID) and group (GID) that the container will run as. For example, `-u 65534:65534` will run the container as the 'nobody'. If you don't specify `-u`, the container will running as `1000:1000`.\
98-
> `-u $(id -u):$(id -g)` Will use your current UID and GID.
132+
> [!NOTE]
133+
> Option `-u <UID>:<GID>` allows you to specify the user (UID) and group (GID) that the container will run as. For example, `-u 0:0` will run the container as root.
134+
>
135+
> - If you don't specify `-u`, the container will running as `1000:1000`.
136+
>
137+
> - Use `-u $(id -u):$(id -g)` to use your current UID and GID.
99138
100-
> For more container arguments, see: [Container Arguments](#container-arguments)
139+
> [!NOTE]
140+
> For Container Variables, see: [Container Variables](#container-variables)
101141
102142
#### **Update the Container Image:**
103143
104-
> See [Official CtbCap Container Registry](#official-ctbcap-container-registry).
144+
See [Official CtbCap Container Registry](#official-ctbcap-container-registry).
105145
106-
### **Container Arguments:**
146+
### **Container Variables:**
107147
108-
| Arguments | Value Type | Value Examples | Default | Necessary to Change |
148+
| Variables | Value Type | Value Examples | Default | Necessary to Change |
109149
| :-: | :-: | :- | :- | :-: |
110150
| MODEL | Streamer's Username <br> or <br> Chatroom URL | `3rd8008` <br> `s1mp_L0r3-87` <br> `https://chaturbate.com/your_sister` <br> `https://stripchat.com/dicklessman` <br> ... | - | Yes |
111151
| PLATFORM | `chaturbate` <br> or <br> `stripchat` | `chaturbate` <br> `stripchat` | `chaturbate` | Yes <br> if not Chaturbate |

0 commit comments

Comments
 (0)