README.md aktualisiert

This commit is contained in:
M_Viper 2024-09-15 20:27:11 +00:00
parent 13f638e992
commit 53d39277ff
1 changed files with 35 additions and 160 deletions

195
README.md
View File

@ -1,160 +1,35 @@
<!DOCTYPE html>
<html lang="de">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Bot-Nutzeranleitung</title>
<style>
body {
font-family: Arial, sans-serif;
line-height: 1.6;
margin: 0;
padding: 0;
background-color: #f4f4f4;
}
.container {
max-width: 800px;
margin: 20px auto;
padding: 20px;
background: #fff;
border-radius: 8px;
box-shadow: 0 0 10px rgba(0, 0, 0, 0.1);
}
h1 {
color: #333;
}
h2 {
color: #555;
border-bottom: 2px solid #eee;
padding-bottom: 5px;
}
p {
margin: 0 0 10px;
}
code {
background: #f4f4f4;
border: 1px solid #ddd;
border-radius: 4px;
padding: 5px;
font-family: monospace;
}
ul {
margin: 0 0 10px;
padding-left: 20px;
}
li {
margin: 5px 0;
}
.spoiler {
margin-top: 20px;
padding: 10px;
border: 1px solid #ddd;
border-radius: 4px;
background: #f9f9f9;
}
.spoiler button {
background-color: #007bff;
color: #fff;
border: none;
padding: 10px;
border-radius: 4px;
cursor: pointer;
}
.spoiler-content {
display: none;
margin-top: 10px;
}
.spoiler-content pre {
background: #f4f4f4;
border: 1px solid #ddd;
border-radius: 4px;
padding: 10px;
font-family: monospace;
}
</style>
</head>
<body>
<div class="container">
<h1>📝 Bot-Nutzeranleitung</h1>
<p>Willkommen zum Telegram-Bot! Hier ist eine einfache Anleitung, wie du die Funktionen des Bots nutzen kannst:</p>
<h2>1. Wunsch äußern</h2>
<ul>
<li><strong>Wunsch-Befehl verwenden</strong></li>
<p><code>/wunsch</code></p>
<p>Beschreibung: Verwende diesen Befehl, um einen Wunsch zu äußern.</p>
<p>Schritt: Der Bot wird dir eine Liste von Kategorien anzeigen, aus denen du auswählen kannst.</p>
<li><strong>Kategorie auswählen</strong></li>
<p>Der Bot zeigt dir ein Inline-Keyboard mit verschiedenen Kategorien wie Film, Serie, Anime, etc. Wähle eine Kategorie aus, die zu deinem Wunsch passt.</p>
<li><strong>Link hinzufügen (Optional)</strong></li>
<p>Der Bot wird dich fragen, ob du einen Link zum Wunsch hinzufügen möchtest (z.B. zu einem Cover oder Spotify). Falls du keinen Link hinzufügen möchtest, kannst du einfach „X“ eingeben.</p>
<li><strong>Titel des Wunsches eingeben</strong></li>
<p>Gib den Titel des Wunsches ein, den du äußern möchtest.</p>
<li><strong>Bestätigen</strong></li>
<p>Der Bot sendet deinen Wunsch an die Gruppe, und du erhältst eine Bestätigung.</p>
</ul>
<h2>2. Wunsch als erfüllt markieren</h2>
<p>Befehl: Diese Funktion ist nur für Admins verfügbar.</p>
<p>Beschreibung: Admins können einen Wunsch als erfüllt markieren, wenn der Wunsch umgesetzt wurde.</p>
<h2>3. Wunsch als „Nicht gefunden“ markieren</h2>
<p>Befehl: Diese Funktion ist nur für Admins verfügbar.</p>
<p>Beschreibung: Admins können Wünsche als „Nicht gefunden“ markieren, wenn der Wunsch nicht gefunden wurde.</p>
<h2>4. Nicht gefundene Wünsche verwalten</h2>
<ul>
<li><strong>Nicht gefundene Wünsche anzeigen</strong></li>
<p>Befehl: <code>/notfound</code></p>
<p>Beschreibung: Zeigt eine Liste aller nicht gefundenen Wünsche an. Nur Admins können diesen Befehl verwenden.</p>
<li><strong>Nicht gefundene Wünsche löschen</strong></li>
<p>Beschreibung: Admins können nicht gefundene Wünsche aus der Liste löschen. Der Bot wird nach der Nummer des Eintrags fragen, den du löschen möchtest.</p>
</ul>
<div class="spoiler">
<button onclick="toggleSpoiler()">Weitere Details anzeigen</button>
<div class="spoiler-content">
<h2>⚙️ Konfigurationsdetails</h2>
<div># folgende Daten müssen beim ersten Start hinterlegt werden</div>
<br /><br />
<div class="config-file">
<p><strong>.env Datei:</strong></p>
<pre>
TELEGRAM_TOKEN="TOKEN"
ALLOWED_CHAT_ID="CHAT-ID"
ALLOWED_THREAD_ID="Channel wo der Bot arbeiten kann (Beispiel 3)"
</pre>
</div>
<p>zu Installierende Pakete:</p>
<ul>
<li><code>npm install telegraf</code></li>
<li><code>npm install path</code></li>
<li><code>npm install fs</code></li>
<li><code>npm install archiver</code></li>
<li><code>npm install</code></li>
<li><code>node-schedule</code></li>
<li><code>npm install dotenv</code></li>
</ul>
</div>
</div>
</div>
<script>
function toggleSpoiler() {
var content = document.querySelector('.spoiler-content');
var button = document.querySelector('.spoiler button');
if (content.style.display === 'block') {
content.style.display = 'none';
button.textContent = 'Weitere Details anzeigen';
} else {
content.style.display = 'block';
button.textContent = 'Details ausblenden';
}
}
</script>
</body>
</html>
<p>📝 Bot-Nutzeranleitung<br />Willkommen zum Telegram-Bot! Hier ist eine einfache Anleitung, wie du die Funktionen des Bots nutzen kannst:</p>
<p>1. Wunsch &auml;u&szlig;ern<br />Wunsch-Befehl verwenden</p>
<p><strong>Befehl: /wunsch:</strong></p>
<p><br />Beschreibung:</p>
<p>Verwende diesen Befehl, um einen Wunsch zu &auml;u&szlig;ern.<br />Schritt: Der Bot wird dir eine Liste von Kategorien anzeigen, aus denen du ausw&auml;hlen kannst.<br />Kategorie ausw&auml;hlen</p>
<p>Der Bot zeigt dir ein Inline-Keyboard mit verschiedenen Kategorien wie Film, Serie, Anime, etc.<br />W&auml;hle eine Kategorie aus, die zu deinem Wunsch passt.<br />Link hinzuf&uuml;gen (Optional)</p>
<p>Der Bot wird dich fragen, ob du einen Link zum Wunsch hinzuf&uuml;gen m&ouml;chtest (z.B. zu einem Cover oder Spotify).<br />Falls du keinen Link hinzuf&uuml;gen m&ouml;chtest, kannst du einfach &bdquo;X&ldquo; eingeben.<br />Titel des Wunsches eingeben</p>
<p>Gib den Titel des Wunsches ein, den du &auml;u&szlig;ern m&ouml;chtest.<br />Best&auml;tigen</p>
<p>Der Bot sendet deinen Wunsch an die Gruppe, und du erh&auml;ltst eine Best&auml;tigung.<br />2. Wunsch als erf&uuml;llt markieren<br />Befehl: Diese Funktion ist nur f&uuml;r Admins verf&uuml;gbar.<br />Beschreibung: Admins k&ouml;nnen einen Wunsch als erf&uuml;llt markieren, wenn der Wunsch umgesetzt wurde.<br />3. Wunsch als &bdquo;Nicht gefunden&ldquo; markieren<br />Befehl: Diese Funktion ist nur f&uuml;r Admins verf&uuml;gbar.<br />Beschreibung: Admins k&ouml;nnen W&uuml;nsche als &bdquo;Nicht gefunden&ldquo; markieren, wenn der Wunsch nicht gefunden wurde.<br />4. Nicht gefundene W&uuml;nsche verwalten<br />Nicht gefundene W&uuml;nsche anzeigen</p>
<p>Befehl: /notfound<br />Beschreibung: Zeigt eine Liste aller nicht gefundenen W&uuml;nsche an. Nur Admins k&ouml;nnen diesen Befehl verwenden.<br />Nicht gefundene W&uuml;nsche l&ouml;schen</p>
<p>Beschreibung: Admins k&ouml;nnen nicht gefundene W&uuml;nsche aus der Liste l&ouml;schen. Der Bot wird nach der Nummer des Eintrags fragen, den du l&ouml;schen m&ouml;chtest.<br /><br /><br /><br /><br /><br /><br /></p>
<p>&nbsp;</p>
<p>&nbsp;</p>
<div>
<div><code># folgende Daten m&uuml;ssen beim ersten Start hinterlegt werden</code></div>
<br /><br /><code>.env Datei:</code></div>
<div><br />
<div>
<div>
<div><code>TELEGRAM_TOKEN="TOKEN"</code></div>
<div><code>ALLOWED_CHAT_ID="CHAT-ID"</code></div>
<div><code>ALLOWED_THREAD_ID="Channel wo der Bot arbeiten kann (Beispiel 3)"</code></div>
<div>&nbsp;</div>
</div>
</div>
<p><code>zu Installierende Pakete:</code><br /><br /><code>npm install telegraf</code></p>
<p><code>npm install path</code></p>
<p><code>npm install fs</code></p>
<p><code>npm install archiver</code></p>
<p><code>npm install</code></p>
<div>
<div><code>node-schedule</code></div>
</div>
<p><code>npm install dotenv</code></p>
</div>