T3SF

T3SF

तकनीकी टेबलटॉप अभ्यास सिमुलेशन फ्रेमवर्क

सामग्री तालिका

• परिचय
• आरंभ करना
• TODO
• CHANGELOG
• योगदान

परिचय

T3SF एक फ्रेमवर्क है जो एक मास्टर परिदृश्य घटना सूची (MSEL) के आधार पर घटनाओं के ऑर्केस्ट्रेशन के लिए एक मॉड्यूलर संरचना प्रदान करता है, साथ ही प्रत्येक अभ्यास के लिए परिभाषित नियमों का एक सेट (वैकल्पिक) और एक कॉन्फ़िगरेशन जो संबंधित प्लेटफॉर्म के मापदंडों को परिभाषित करने की अनुमति देता है। मुख्य मॉड्यूल विशिष्ट मॉड्यूल (Discord, Slack, Telegram, आदि) के साथ संचार करता है जो प्रत्येक प्लेटफॉर्म के लिए इनपुट चैनलों में इंजेक्ट के रूप में घटनाओं को प्रस्तुत करने की अनुमति देता है। इसके अलावा, फ्रेमवर्क विभिन्न उपयोग मामलों का समर्थन करता है: "एकल संगठन, एकाधिक क्षेत्र", "एकाधिक संगठन, एकल क्षेत्र" और "एकाधिक संगठन, एकाधिक क्षेत्र"।

आरंभ करना

अपने वांछित प्लेटफॉर्म, चाहे वह Slack हो या Discord, के साथ फ्रेमवर्क का उपयोग करने के लिए, आपको उस प्लेटफॉर्म के लिए आवश्यक मॉड्यूल स्थापित करने होंगे। लेकिन चिंता न करें, इन मॉड्यूल को स्थापित करना आसान और सीधा है।

ऐसा करने के लिए, आप इस सरल चरण-दर-चरण मार्गदर्शिका का पालन कर सकते हैं, या यदि आप पहले से ही pip के साथ पैकेज स्थापित करने में सहज हैं, तो आप अंतिम चरण पर जा सकते हैं!

# Python 3.6+ आवश्यक
python -m venv .venv       # हम एक पायथन वर्चुअल वातावरण बनाएंगे
source .venv/bin/activate  # आइए इसमें प्रवेश करें

pip install -U pip         # pip को अपग्रेड करें

एक बार जब आप पायथन वर्चुअल वातावरण बना लेते हैं और इसे सक्रिय कर लेते हैं, तो आप अपने वांछित प्लेटफॉर्म के लिए T3SF फ्रेमवर्क को निम्नलिखित कमांड चलाकर स्थापित कर सकते हैं:

pip install "T3SF[Discord]"  # Discord के साथ काम करने के लिए फ्रेमवर्क स्थापित करें

या

pip install "T3SF[Slack]"  # Slack के साथ काम करने के लिए फ्रेमवर्क स्थापित करें

यह आपके चुने हुए प्लेटफॉर्म के लिए आवश्यक निर्भरताओं के साथ T3SF फ्रेमवर्क को स्थापित करेगा। एक बार स्थापना पूर्ण हो जाने पर, आप अपने चुने हुए प्लेटफॉर्म के साथ फ्रेमवर्क का उपयोग शुरू कर सकते हैं।

हम दृढ़ता से अनुशंसा करते हैं कि आप हमारे Read The Docs के भीतर प्लेटफॉर्म-विशिष्ट मार्गदर्शन का पालन करें! यहाँ लिंक दिए गए हैं:

• Discord
• Slack
• Telegram
• WhatsApp

उपयोग

हमने इस फ्रेमवर्क को आपके सभी कार्यों को सरल बनाने के लिए बनाया है!

$ docker run --rm -t --env-file .env -v $(pwd)/MSEL.json:/app/MSEL.json base4sec/t3sf:slack

$ docker run --rm -t --env-file .env -v $(pwd)/MSEL.json:/app/MSEL.json base4sec/t3sf:discord

एक बार जब आप सब कुछ तैयार कर लेते हैं, तो main.py के लिए हमारे टेम्पलेट का उपयोग करें, या निम्नलिखित कोड को संशोधित करें:

यहाँ एक उदाहरण है यदि आप Discord बॉट और GUI के साथ फ्रेमवर्क चलाना चाहते हैं।

from T3SF import T3SF
import asyncio

async def main():
    await T3SF.start(MSEL="MSEL_TTX.json", platform="Discord", gui=True)

if __name__ == '__main__':
    asyncio.run(main())

या यदि आप GUI के बिना और इसके बजाय Slack के साथ फ्रेमवर्क चलाना पसंद करते हैं, तो आप तर्कों को संशोधित कर सकते हैं, और बस!

हाँ, यह इतना सरल है!

await T3SF.start(MSEL="MSEL_TTX.json", platform="Slack", gui=False)

यदि आपको अधिक सहायता चाहिए, तो आप हमेशा हमारे दस्तावेज़ यहाँ देख सकते हैं!