واجهة اللوحات البرمجية
يمكن لبوتك الخاص أن يطلب من OFFlimits رسم لوحة نتائج واستلام الصورة. كل اللوحات — بما فيها اللوحات المخصصة — مجانية لكل خادم.
الاستخدام
أرسل طلب POST إلى https://api.offlimitsbot.com/api/board مع الترويسة Authorization: Bearer <your API key>.
| الحقل | إلزامي | الوصف |
|---|---|---|
server_id (أو guild) | نعم | معرّف الخادم، أو كائن Guild مُسلسَل من discord.js |
board_number | نعم | 1 أو 2 (نصية) أو 3 أو 4 أو 6 أو 7 أو 8، أو 5 / "custom" للوحة الخادم المخصصة |
messages | لا | أسطر النتائج، مثال: ["[TEAM A] 1 12", "[TEAM B] 2 5"] |
channel_id | عند غياب messages | قناة يحتوي اسمها على results؛ يقرأ OFFlimits آخر 70 رسالة فيها |
board_id | لا | أيّ لوحة من لوحات الخادم المخصصة تُرسم (معرّفها، من رابط لوحة التحكم /custom-board/<id>)؛ الافتراضي: اللوحة المختارة بالأمر /setboard boards select |
board_name | لا | الشيء نفسه، باستخدام اسم اللوحة (دون تمييز بين الأحرف الكبيرة والصغيرة) |
share_link | لا | الشيء نفسه، باستخدام رابط مشاركة اللوحة (/setboard share create) |
server_name | لا | الاسم الذي يُرسم في ترويسة اللوحة |
يُستخدم نظام النقاط الخاص بالخادم (المضبوط بالأمر /setpoints أو من لوحة التحكم).
النتيجة
{ "image": "data:image/png;base64,iVBORw0KGgo..." }
تُعيد اللوحات النصية (1 و2) { "content": "```...```" }؛ أما عند حدوث مشكلة فتُعاد { "error": "..." } مع رمز HTTP 422. أضف ?format=png إلى الرابط للحصول على ملف PNG نفسه بدلًا من JSON.
أمثلة برمجية
JavaScript
const { AttachmentBuilder } = require("discord.js");
const response = await fetch("https://api.offlimitsbot.com/api/board?format=png", {
method: "POST",
headers: { Authorization: `Bearer ${API_KEY}`, "Content-Type": "application/json" },
body: JSON.stringify({
server_id: interaction.guild.id,
channel_id: resultsChannel.id, // أو: messages: ["[TEAM A] 1 12", ...]
board_number: 3,
}),
});
if (!response.ok) throw new Error((await response.json()).error);
const attachment = new AttachmentBuilder(Buffer.from(await response.arrayBuffer()), {
name: "OFFlimits-board.png",
});
await interaction.editReply({ files: [attachment] });
Python
import aiohttp
async with aiohttp.ClientSession() as session:
async with session.post(
"https://api.offlimitsbot.com/api/board?format=png",
headers={"Authorization": f"Bearer {API_KEY}"},
json={"server_id": guild_id, "channel_id": channel_id, "board_number": 3},
) as resp:
png_bytes = await resp.read() # صورة اللوحة
