@@ -1,192 +0,0 @@ | |||||
# Makefile for Sphinx documentation | |||||
# | |||||
# You can set these variables from the command line. | |||||
SPHINXOPTS = | |||||
SPHINXBUILD = sphinx-build | |||||
PAPER = | |||||
BUILDDIR = _build | |||||
# User-friendly check for sphinx-build | |||||
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) | |||||
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) | |||||
endif | |||||
# Internal variables. | |||||
PAPEROPT_a4 = -D latex_paper_size=a4 | |||||
PAPEROPT_letter = -D latex_paper_size=letter | |||||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . | |||||
# the i18n builder cannot share the environment and doctrees with the others | |||||
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . | |||||
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext | |||||
help: | |||||
@echo "Please use \`make <target>' where <target> is one of" | |||||
@echo " html to make standalone HTML files" | |||||
@echo " dirhtml to make HTML files named index.html in directories" | |||||
@echo " singlehtml to make a single large HTML file" | |||||
@echo " pickle to make pickle files" | |||||
@echo " json to make JSON files" | |||||
@echo " htmlhelp to make HTML files and a HTML help project" | |||||
@echo " qthelp to make HTML files and a qthelp project" | |||||
@echo " applehelp to make an Apple Help Book" | |||||
@echo " devhelp to make HTML files and a Devhelp project" | |||||
@echo " epub to make an epub" | |||||
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" | |||||
@echo " latexpdf to make LaTeX files and run them through pdflatex" | |||||
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" | |||||
@echo " text to make text files" | |||||
@echo " man to make manual pages" | |||||
@echo " texinfo to make Texinfo files" | |||||
@echo " info to make Texinfo files and run them through makeinfo" | |||||
@echo " gettext to make PO message catalogs" | |||||
@echo " changes to make an overview of all changed/added/deprecated items" | |||||
@echo " xml to make Docutils-native XML files" | |||||
@echo " pseudoxml to make pseudoxml-XML files for display purposes" | |||||
@echo " linkcheck to check all external links for integrity" | |||||
@echo " doctest to run all doctests embedded in the documentation (if enabled)" | |||||
@echo " coverage to run coverage check of the documentation (if enabled)" | |||||
clean: | |||||
rm -rf $(BUILDDIR)/* | |||||
html: | |||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html | |||||
@echo | |||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html." | |||||
dirhtml: | |||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml | |||||
@echo | |||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." | |||||
singlehtml: | |||||
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml | |||||
@echo | |||||
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." | |||||
pickle: | |||||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle | |||||
@echo | |||||
@echo "Build finished; now you can process the pickle files." | |||||
json: | |||||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json | |||||
@echo | |||||
@echo "Build finished; now you can process the JSON files." | |||||
htmlhelp: | |||||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp | |||||
@echo | |||||
@echo "Build finished; now you can run HTML Help Workshop with the" \ | |||||
".hhp project file in $(BUILDDIR)/htmlhelp." | |||||
qthelp: | |||||
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp | |||||
@echo | |||||
@echo "Build finished; now you can run "qcollectiongenerator" with the" \ | |||||
".qhcp project file in $(BUILDDIR)/qthelp, like this:" | |||||
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/DiscordNet.qhcp" | |||||
@echo "To view the help file:" | |||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/DiscordNet.qhc" | |||||
applehelp: | |||||
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp | |||||
@echo | |||||
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp." | |||||
@echo "N.B. You won't be able to view it unless you put it in" \ | |||||
"~/Library/Documentation/Help or install it in your application" \ | |||||
"bundle." | |||||
devhelp: | |||||
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp | |||||
@echo | |||||
@echo "Build finished." | |||||
@echo "To view the help file:" | |||||
@echo "# mkdir -p $$HOME/.local/share/devhelp/DiscordNet" | |||||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/DiscordNet" | |||||
@echo "# devhelp" | |||||
epub: | |||||
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub | |||||
@echo | |||||
@echo "Build finished. The epub file is in $(BUILDDIR)/epub." | |||||
latex: | |||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex | |||||
@echo | |||||
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." | |||||
@echo "Run \`make' in that directory to run these through (pdf)latex" \ | |||||
"(use \`make latexpdf' here to do that automatically)." | |||||
latexpdf: | |||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex | |||||
@echo "Running LaTeX files through pdflatex..." | |||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf | |||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." | |||||
latexpdfja: | |||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex | |||||
@echo "Running LaTeX files through platex and dvipdfmx..." | |||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja | |||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." | |||||
text: | |||||
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text | |||||
@echo | |||||
@echo "Build finished. The text files are in $(BUILDDIR)/text." | |||||
man: | |||||
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man | |||||
@echo | |||||
@echo "Build finished. The manual pages are in $(BUILDDIR)/man." | |||||
texinfo: | |||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo | |||||
@echo | |||||
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." | |||||
@echo "Run \`make' in that directory to run these through makeinfo" \ | |||||
"(use \`make info' here to do that automatically)." | |||||
info: | |||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo | |||||
@echo "Running Texinfo files through makeinfo..." | |||||
make -C $(BUILDDIR)/texinfo info | |||||
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." | |||||
gettext: | |||||
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale | |||||
@echo | |||||
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." | |||||
changes: | |||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes | |||||
@echo | |||||
@echo "The overview file is in $(BUILDDIR)/changes." | |||||
linkcheck: | |||||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck | |||||
@echo | |||||
@echo "Link check complete; look for any errors in the above output " \ | |||||
"or in $(BUILDDIR)/linkcheck/output.txt." | |||||
doctest: | |||||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest | |||||
@echo "Testing of doctests in the sources finished, look at the " \ | |||||
"results in $(BUILDDIR)/doctest/output.txt." | |||||
coverage: | |||||
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage | |||||
@echo "Testing of coverage in the sources finished, look at the " \ | |||||
"results in $(BUILDDIR)/coverage/python.txt." | |||||
xml: | |||||
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml | |||||
@echo | |||||
@echo "Build finished. The XML files are in $(BUILDDIR)/xml." | |||||
pseudoxml: | |||||
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml | |||||
@echo | |||||
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." |
@@ -1,288 +0,0 @@ | |||||
# -*- coding: utf-8 -*- | |||||
# | |||||
# Discord.Net documentation build configuration file, created by | |||||
# sphinx-quickstart on Sun Sep 27 16:59:56 2015. | |||||
# | |||||
# This file is execfile()d with the current directory set to its | |||||
# containing dir. | |||||
# | |||||
# Note that not all possible configuration values are present in this | |||||
# autogenerated file. | |||||
# | |||||
# All configuration values have a default; values that are commented out | |||||
# serve to show the default. | |||||
import sys | |||||
import os | |||||
import shlex | |||||
# If extensions (or modules to document with autodoc) are in another directory, | |||||
# add these directories to sys.path here. If the directory is relative to the | |||||
# documentation root, use os.path.abspath to make it absolute, like shown here. | |||||
#sys.path.insert(0, os.path.abspath('.')) | |||||
# -- General configuration ------------------------------------------------ | |||||
# If your documentation needs a minimal Sphinx version, state it here. | |||||
#needs_sphinx = '1.0' | |||||
# Add any Sphinx extension module names here, as strings. They can be | |||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | |||||
# ones. | |||||
sys.path.append(os.path.abspath('exts')) | |||||
extensions = ['csharp6'] | |||||
# Add any paths that contain templates here, relative to this directory. | |||||
templates_path = ['_templates'] | |||||
# The suffix(es) of source filenames. | |||||
# You can specify multiple suffix as a list of string: | |||||
# source_suffix = ['.rst', '.md'] | |||||
source_suffix = '.rst' | |||||
# The encoding of source files. | |||||
#source_encoding = 'utf-8-sig' | |||||
# The master toctree document. | |||||
master_doc = 'index' | |||||
# General information about the project. | |||||
project = u'Discord.Net' | |||||
copyright = u'2015, RogueException' | |||||
author = u'RogueException' | |||||
# The version info for the project you're documenting, acts as replacement for | |||||
# |version| and |release|, also used in various other places throughout the | |||||
# built documents. | |||||
# | |||||
# The short X.Y version. | |||||
version = '0.7' | |||||
# The full version, including alpha/beta/rc tags. | |||||
release = '0.7.1b1' | |||||
# The language for content autogenerated by Sphinx. Refer to documentation | |||||
# for a list of supported languages. | |||||
# | |||||
# This is also used if you do content translation via gettext catalogs. | |||||
# Usually you set "language" from the command line for these cases. | |||||
language = None | |||||
# There are two options for replacing |today|: either, you set today to some | |||||
# non-false value, then it is used: | |||||
#today = '' | |||||
# Else, today_fmt is used as the format for a strftime call. | |||||
#today_fmt = '%B %d, %Y' | |||||
# List of patterns, relative to source directory, that match files and | |||||
# directories to ignore when looking for source files. | |||||
exclude_patterns = ['_build'] | |||||
# The reST default role (used for this markup: `text`) to use for all | |||||
# documents. | |||||
#default_role = None | |||||
# If true, '()' will be appended to :func: etc. cross-reference text. | |||||
#add_function_parentheses = True | |||||
# If true, the current module name will be prepended to all description | |||||
# unit titles (such as .. function::). | |||||
#add_module_names = True | |||||
# If true, sectionauthor and moduleauthor directives will be shown in the | |||||
# output. They are ignored by default. | |||||
#show_authors = False | |||||
# The name of the Pygments (syntax highlighting) style to use. | |||||
pygments_style = 'sphinx' | |||||
# A list of ignored prefixes for module index sorting. | |||||
#modindex_common_prefix = [] | |||||
# If true, keep warnings as "system message" paragraphs in the built documents. | |||||
#keep_warnings = False | |||||
# If true, `todo` and `todoList` produce output, else they produce nothing. | |||||
todo_include_todos = False | |||||
rst_prolog = """ | |||||
.. include:: /global.txt | |||||
""" | |||||
# -- Options for HTML output ---------------------------------------------- | |||||
# The theme to use for HTML and HTML Help pages. See the documentation for | |||||
# a list of builtin themes. | |||||
#html_theme = 'alabaster' | |||||
# Theme options are theme-specific and customize the look and feel of a theme | |||||
# further. For a list of options available for each theme, see the | |||||
# documentation. | |||||
#html_theme_options = {} | |||||
# Add any paths that contain custom themes here, relative to this directory. | |||||
#html_theme_path = [] | |||||
# The name for this set of Sphinx documents. If None, it defaults to | |||||
# "<project> v<release> documentation". | |||||
#html_title = None | |||||
# A shorter title for the navigation bar. Default is the same as html_title. | |||||
#html_short_title = None | |||||
# The name of an image file (relative to this directory) to place at the top | |||||
# of the sidebar. | |||||
#html_logo = None | |||||
# The name of an image file (within the static path) to use as favicon of the | |||||
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 | |||||
# pixels large. | |||||
#html_favicon = None | |||||
# Add any paths that contain custom static files (such as style sheets) here, | |||||
# relative to this directory. They are copied after the builtin static files, | |||||
# so a file named "default.css" will overwrite the builtin "default.css". | |||||
html_static_path = ['_static'] | |||||
# Add any extra paths that contain custom files (such as robots.txt or | |||||
# .htaccess) here, relative to this directory. These files are copied | |||||
# directly to the root of the documentation. | |||||
#html_extra_path = [] | |||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, | |||||
# using the given strftime format. | |||||
#html_last_updated_fmt = '%b %d, %Y' | |||||
# If true, SmartyPants will be used to convert quotes and dashes to | |||||
# typographically correct entities. | |||||
#html_use_smartypants = True | |||||
# Custom sidebar templates, maps document names to template names. | |||||
#html_sidebars = {} | |||||
# Additional templates that should be rendered to pages, maps page names to | |||||
# template names. | |||||
#html_additional_pages = {} | |||||
# If false, no module index is generated. | |||||
#html_domain_indices = True | |||||
# If false, no index is generated. | |||||
#html_use_index = True | |||||
# If true, the index is split into individual pages for each letter. | |||||
#html_split_index = False | |||||
# If true, links to the reST sources are added to the pages. | |||||
#html_show_sourcelink = True | |||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. | |||||
#html_show_sphinx = True | |||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. | |||||
#html_show_copyright = True | |||||
# If true, an OpenSearch description file will be output, and all pages will | |||||
# contain a <link> tag referring to it. The value of this option must be the | |||||
# base URL from which the finished HTML is served. | |||||
#html_use_opensearch = '' | |||||
# This is the file name suffix for HTML files (e.g. ".xhtml"). | |||||
#html_file_suffix = None | |||||
# Language to be used for generating the HTML full-text search index. | |||||
# Sphinx supports the following languages: | |||||
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' | |||||
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' | |||||
#html_search_language = 'en' | |||||
# A dictionary with options for the search language support, empty by default. | |||||
# Now only 'ja' uses this config value | |||||
#html_search_options = {'type': 'default'} | |||||
# The name of a javascript file (relative to the configuration directory) that | |||||
# implements a search results scorer. If empty, the default will be used. | |||||
#html_search_scorer = 'scorer.js' | |||||
# Output file base name for HTML help builder. | |||||
htmlhelp_basename = 'DiscordNetdoc' | |||||
# -- Options for LaTeX output --------------------------------------------- | |||||
latex_elements = { | |||||
# The paper size ('letterpaper' or 'a4paper'). | |||||
#'papersize': 'letterpaper', | |||||
# The font size ('10pt', '11pt' or '12pt'). | |||||
#'pointsize': '10pt', | |||||
# Additional stuff for the LaTeX preamble. | |||||
#'preamble': '', | |||||
# Latex figure (float) alignment | |||||
#'figure_align': 'htbp', | |||||
} | |||||
# Grouping the document tree into LaTeX files. List of tuples | |||||
# (source start file, target name, title, | |||||
# author, documentclass [howto, manual, or own class]). | |||||
latex_documents = [ | |||||
(master_doc, 'DiscordNet.tex', u'Discord.Net Documentation', | |||||
u'RogueException', 'manual'), | |||||
] | |||||
# The name of an image file (relative to this directory) to place at the top of | |||||
# the title page. | |||||
#latex_logo = None | |||||
# For "manual" documents, if this is true, then toplevel headings are parts, | |||||
# not chapters. | |||||
#latex_use_parts = False | |||||
# If true, show page references after internal links. | |||||
#latex_show_pagerefs = False | |||||
# If true, show URL addresses after external links. | |||||
#latex_show_urls = False | |||||
# Documents to append as an appendix to all manuals. | |||||
#latex_appendices = [] | |||||
# If false, no module index is generated. | |||||
#latex_domain_indices = True | |||||
# -- Options for manual page output --------------------------------------- | |||||
# One entry per manual page. List of tuples | |||||
# (source start file, name, description, authors, manual section). | |||||
man_pages = [ | |||||
(master_doc, 'discordnet', u'Discord.Net Documentation', | |||||
[author], 1) | |||||
] | |||||
# If true, show URL addresses after external links. | |||||
#man_show_urls = False | |||||
# -- Options for Texinfo output ------------------------------------------- | |||||
# Grouping the document tree into Texinfo files. List of tuples | |||||
# (source start file, target name, title, author, | |||||
# dir menu entry, description, category) | |||||
texinfo_documents = [ | |||||
(master_doc, 'DiscordNet', u'Discord.Net Documentation', | |||||
author, 'DiscordNet', 'One line description of project.', | |||||
'Miscellaneous'), | |||||
] | |||||
# Documents to append as an appendix to all manuals. | |||||
#texinfo_appendices = [] | |||||
# If false, no module index is generated. | |||||
#texinfo_domain_indices = True | |||||
# How to display URL addresses: 'footnote', 'no', or 'inline'. | |||||
#texinfo_show_urls = 'footnote' | |||||
# If true, do not generate a @detailmenu in the "Top" node's menu. | |||||
#texinfo_no_detailmenu = False |
@@ -1,79 +0,0 @@ | |||||
# -*- coding: utf-8 -*- | |||||
import re | |||||
from pygments.lexer import RegexLexer, DelegatingLexer, bygroups, include, using, this, default | |||||
from pygments.token import Punctuation, Text, Comment, Operator, Keyword, Name, String, Number, Literal, Other | |||||
from pygments.util import get_choice_opt, iteritems | |||||
from pygments import unistring as uni | |||||
from pygments.lexers.html import XmlLexer | |||||
class CSharp6Lexer(RegexLexer): | |||||
name = 'C#6' | |||||
aliases = ['csharp6', 'c#6'] | |||||
filenames = ['*.cs'] | |||||
mimetypes = ['text/x-csharp'] | |||||
flags = re.MULTILINE | re.DOTALL | re.UNICODE | |||||
cs_ident = ('@?[_' + uni.combine('Lu', 'Ll', 'Lt', 'Lm', 'Nl') + ']' + | |||||
'[' + uni.combine('Lu', 'Ll', 'Lt', 'Lm', 'Nl', 'Nd', 'Pc', | |||||
'Cf', 'Mn', 'Mc') + ']*') | |||||
tokens = { | |||||
'root': [ | |||||
# method names | |||||
(r'^([ \t]*(?:' + cs_ident + r'(?:\[\])?\s+)+?)' # return type | |||||
r'(' + cs_ident + ')' # method name | |||||
r'(\s*)(\()', # signature start | |||||
bygroups(using(this), Name.Function, Text, Punctuation)), | |||||
(r'^\s*\[.*?\]', Name.Attribute), | |||||
(r'[^\S\n]+', Text), | |||||
(r'\\\n', Text), # line continuation | |||||
(r'//.*?\n', Comment.Single), | |||||
(r'/[*].*?[*]/', Comment.Multiline), | |||||
(r'\n', Text), | |||||
(r'[~!%^&*()+=|\[\]:;,.<>/?-]', Punctuation), | |||||
(r'[{}]', Punctuation), | |||||
(r'@\$?"(""|[^"])*"', String), | |||||
(r'"\$?(\\\\|\\"|[^"\n])*["\n]', String), | |||||
(r"'\\.'|'[^\\]'", String.Char), | |||||
(r"[0-9](\.[0-9]*)?([eE][+-][0-9]+)?" | |||||
r"[flFLdD]?|0[xX][0-9a-fA-F]+[Ll]?", Number), | |||||
(r'#[ \t]*(if|endif|else|elif|define|undef|' | |||||
r'line|error|warning|region|endregion|pragma)\b.*?\n', | |||||
Comment.Preproc), | |||||
(r'\b(extern)(\s+)(alias)\b', bygroups(Keyword, Text, | |||||
Keyword)), | |||||
(r'(abstract|as|async|await|base|break|case|catch|' | |||||
r'checked|const|continue|default|delegate|' | |||||
r'do|else|enum|event|explicit|extern|false|finally|' | |||||
r'fixed|for|foreach|goto|if|implicit|in|interface|' | |||||
r'internal|is|lock|new|null|operator|' | |||||
r'out|override|params|private|protected|public|readonly|' | |||||
r'ref|return|sealed|sizeof|stackalloc|static|' | |||||
r'switch|this|throw|true|try|typeof|' | |||||
r'unchecked|unsafe|virtual|var|void|while|' | |||||
r'get|set|new|partial|yield|add|remove|value|alias|ascending|' | |||||
r'descending|from|group|into|orderby|select|where|' | |||||
r'join|equals)\b', Keyword), | |||||
(r'(global)(::)', bygroups(Keyword, Punctuation)), | |||||
(r'(bool|byte|char|decimal|double|dynamic|float|int|long|object|' | |||||
r'sbyte|short|string|uint|ulong|ushort|var)\b\??', Keyword.Type), | |||||
(r'(class|struct)(\s+)', bygroups(Keyword, Text), 'class'), | |||||
(r'(namespace|using)(\s+)', bygroups(Keyword, Text), 'namespace'), | |||||
(cs_ident, Name), | |||||
], | |||||
'class': [ | |||||
(cs_ident, Name.Class, '#pop'), | |||||
default('#pop'), | |||||
], | |||||
'namespace': [ | |||||
(r'(?=\()', Text, '#pop'), # using (resource) | |||||
('(' + cs_ident + r'|\.)+', Name.Namespace, '#pop'), | |||||
] | |||||
} | |||||
def setup(app): | |||||
from sphinx.highlighting import lexers | |||||
lexers['csharp6'] = CSharp6Lexer() |
@@ -1,20 +0,0 @@ | |||||
|stub| Commands | |||||
=============== | |||||
The `Discord.Net.Commands`_ package DiscordBotClient extends DiscordClient with support for commands. | |||||
.. _Discord.Net.Commands: https://www.nuget.org/packages/Discord.Net.Commands | |||||
Example (Simple) | |||||
---------------- | |||||
.. literalinclude:: /samples/command.cs | |||||
:language: csharp6 | |||||
:tab-width: 2 | |||||
Example (Groups) | |||||
---------------- | |||||
.. literalinclude:: /samples/command_group.cs | |||||
:language: csharp6 | |||||
:tab-width: 2 |
@@ -1,78 +0,0 @@ | |||||
Events | |||||
====== | |||||
Usage | |||||
----- | |||||
Messages from the Discord server are exposed via events on the DiscordClient class and follow the standard EventHandler<EventArgs> C# pattern. | |||||
.. warning:: | |||||
Note that all synchronous code in an event handler will run on the gateway socket's thread and should be handled as quickly as possible. | |||||
Using the async-await pattern to let the thread continue immediately is recommended and is demonstrated in the examples below. | |||||
Connection State | |||||
---------------- | |||||
Connection Events will be raised when the Connection State of your client changes. | |||||
.. warning:: | |||||
You should not use DiscordClient.Connected to run code when your client first connects to Discord. | |||||
If you lose connection and automatically reconnect, this code will be ran again, which may lead to unexpected behavior. | |||||
Messages | |||||
-------- | |||||
- MessageReceived, MessageUpdated and MessageDeleted are raised when a new message arrives, an existing one has been updated (by the user, or by Discord itself), or deleted. | |||||
- MessageAcknowledged is only triggered in client mode, and occurs when a message is read on another device logged-in with your account. | |||||
Example of MessageReceived: | |||||
.. code-block:: c# | |||||
// (Preface: Echo Bots are discouraged, make sure your bot is not running in a public server if you use them) | |||||
// Hook into the MessageReceived event using a Lambda | |||||
_client.MessageReceived += async (s, e) => { | |||||
// Check to make sure that the bot is not the author | |||||
if (!e.Message.IsAuthor) | |||||
// Echo the message back to the channel | |||||
await e.Channel.SendMessage(e.Message); | |||||
}; | |||||
Users | |||||
----- | |||||
There are several user events: | |||||
- UserBanned: A user has been banned from a server. | |||||
- UserUnbanned: A user was unbanned. | |||||
- UserJoined: A user joins a server. | |||||
- UserLeft: A user left (or was kicked from) a server. | |||||
- UserIsTyping: A user in a channel starts typing. | |||||
- UserUpdated: A user object was updated (presence update, role/permission change, or a voice state update). | |||||
.. note:: | |||||
UserUpdated Events include a ``User`` object for Before and After the change. | |||||
When accessing the User, you should only use ``e.Before`` if comparing changes, otherwise use ``e.After`` | |||||
Examples: | |||||
.. code-block:: c# | |||||
// Register a Hook into the UserBanned event using a Lambda | |||||
_client.UserBanned += async (s, e) => { | |||||
// Create a Channel object by searching for a channel named '#logs' on the server the ban occurred in. | |||||
var logChannel = e.Server.FindChannels("logs").FirstOrDefault(); | |||||
// Send a message to the server's log channel, stating that a user was banned. | |||||
await logChannel.SendMessage($"User Banned: {e.User.Name}"); | |||||
}; | |||||
// Register a Hook into the UserUpdated event using a Lambda | |||||
_client.UserUpdated += async (s, e) => { | |||||
// Check that the user is in a Voice channel | |||||
if (e.After.VoiceChannel == null) return; | |||||
// See if they changed Voice channels | |||||
if (e.Before.VoiceChannel == e.After.VoiceChannel) return; | |||||
await logChannel.SendMessage($"User {e.After.Name} changed voice channels!"); | |||||
}; |
@@ -1,35 +0,0 @@ | |||||
Logging | |||||
======= | |||||
Discord.Net will log all of its events/exceptions using a built-in LogManager. | |||||
This LogManager can be accessed through DiscordClient.Log | |||||
Usage | |||||
----- | |||||
To handle Log Messages through Discord.Net's Logger, you must hook into the Log.Message<LogMessageEventArgs> Event. | |||||
The LogManager does not provide a string-based result for the message, you must put your own message format together using the data provided through LogMessageEventArgs | |||||
See the Example for a snippet of logging. | |||||
Logging Your Own Data | |||||
--------------------- | |||||
The LogManager included in Discord.Net can also be used to log your own messages. | |||||
You can use DiscordClient.Log.Log(LogSeverity, Source, Message, Exception), or one of the shortcut helpers, to log data. | |||||
Example: | |||||
.. code-block:: c# | |||||
_client.MessageReceived += async (s, e) { | |||||
// Log a new Message with Severity Info, Sourced from 'MessageReceived', with the Message Contents. | |||||
_client.Log.Info("MessageReceived", e.Message.Text, null); | |||||
}; | |||||
Example | |||||
------- | |||||
.. literalinclude:: /samples/logging.cs | |||||
:language: c# | |||||
:tab-width: 2 |
@@ -1,75 +0,0 @@ | |||||
Permissions | |||||
=========== | |||||
There are two types of permissions: *Channel Permissions* and *Server Permissions*. | |||||
Channel Permissions | |||||
------------------- | |||||
Channel Permissions are controlled using a set of flags: | |||||
======================= ======= ============== | |||||
Flag Type Description | |||||
======================= ======= ============== | |||||
AttachFiles Text Send files to a channel. | |||||
Connect Voice Connect to a voice channel. | |||||
CreateInstantInvite General Create an invite to the channel. | |||||
DeafenMembers Voice Prevent users of a voice channel from hearing other users (server-wide). | |||||
EmbedLinks Text Create embedded links. | |||||
ManageChannel General Manage a channel. | |||||
ManageMessages Text Remove messages in a channel. | |||||
ManagePermissions General Manage the permissions of a channel. | |||||
MentionEveryone Text Use @everyone in a channel. | |||||
MoveMembers Voice Move members around in voice channels. | |||||
MuteMembers Voice Mute users of a voice channel (server-wide). | |||||
ReadMessageHistory Text Read the chat history of a voice channel. | |||||
ReadMessages Text Read any messages in a text channel; exposes the text channel to users. | |||||
SendMessages Text Send messages in a text channel. | |||||
SendTTSMessages Text Send TTS messages in a text channel. | |||||
Speak Voice Speak in a voice channel. | |||||
UseVoiceActivation Voice Use Voice Activation in a text channel (for large channels where PTT is preferred) | |||||
======================= ======= ============== | |||||
If a user has a permission, the value is true. Otherwise, it must be null. | |||||
Dual Channel Permissions | |||||
------------------------ | |||||
You may also access a user's permissions in a channel with the DualChannelPermissions class. | |||||
Unlike normal ChannelPermissions, DualChannelPermissions hold three values: | |||||
If a user has a permission, the value is true. If a user is denied a permission, it will be false. If the permission is not set, the value will return null. | |||||
Setting Channel Permissions | |||||
--------------------------- | |||||
To set channel permissions, you may use either two ChannelPermissions, or one DualChannelPermissions. | |||||
In the case of using two Channel Permissions, you must create one list of allowed permissions, and one list of denied permissions. | |||||
Otherwise, you can use a single DualChannelPermissions. | |||||
Server Permissions | |||||
------------------ | |||||
Server Permissions can be accessed by ``Server.GetPermissions(User)``, and updated with ``Server.UpdatePermissions(User, ServerPermissions)`` | |||||
A user's server permissions also contain the default values for it's channel permissions, so the channel permissions listed above are also valid flags for Server Permissions. There are also a few extra Server Permissions: | |||||
======================= ======= ============== | |||||
Flag Type Description | |||||
======================= ======= ============== | |||||
BanMembers Server Ban users from the server. | |||||
KickMembers Server Kick users from the server. They can still rejoin. | |||||
ManageRoles Server Manage roles on the server, and their permissions. | |||||
ManageChannels Server Manage channels that exist on the server (add, remove them) | |||||
ManageServer Server Manage the server settings. | |||||
Roles | |||||
----- | |||||
Managing permissions for roles is much easier than for users in channels. For roles, just access the flag under `Role.Permissions`. | |||||
Example | |||||
------- | |||||
.. literalinclude:: /samples/permissions.cs | |||||
:language: csharp6 | |||||
:tab-width: 2 |
@@ -1,53 +0,0 @@ | |||||
Server Management | |||||
================= | |||||
Discord.Net will allow you to manage most settings of a Discord server. | |||||
Usage | |||||
----- | |||||
You can create Channels, Invites, and Roles on a server using the CreateChannel, CreateInvite, and CreateRole function of a Server, respectively. | |||||
You may also edit a server's name, icon, and region. | |||||
.. code-block:: c# | |||||
// Create a Channel and retrieve the Channel object | |||||
var _channel = await _server.CreateChannel("announcements", ChannelType.Text); | |||||
// Create an Invite and retrieve the Invite object | |||||
var _invite = await _server.CreateInvite(maxAge: null, maxUses: 25, tempMembership: false, withXkcd: false); | |||||
// Create a Role and retrieve the Role object | |||||
var _role = await _server.CreateRole(name: "Bots", permissions: null, color: Color.DarkMagenta, isHoisted: false); | |||||
// Edit a server | |||||
var _ioStream = new System.IO.StreamReader("clock-0500-1952.png").BaseStream | |||||
_server.Edit(name: "19:52 | UTC-05:00", region: "east", icon: _ioStream, iconType: ImageType.Png); | |||||
// Prune Users | |||||
var _pruneCount = await _server.PruneUsers(30, true); | |||||
Invite Parameters | |||||
----------------- | |||||
maxAge: The time (in seconds) until the invite expires. Use null for infinite. | |||||
maxUses: The maximum amount of uses the invite has before it expires. | |||||
tempMembership: Whether or not to kick a user when they disconnect. | |||||
withXkcd: Generate the invite with an XKCD 936 style URL | |||||
Role Parameters | |||||
--------------- | |||||
name: The name of the role | |||||
permissions: A set of ServerPermissions for the role to use by default | |||||
color: The color of the role, recommended to use Discord.Color | |||||
isHoisted: Whether a role's users should be displayed separately from other users in the user list. | |||||
Edit Parameters | |||||
--------------- | |||||
name: The server's name | |||||
region: The region the voice server is hosted in | |||||
icon: A System.IO.Stream that will read an image file | |||||
iconType: The type of image being sent (png/jpeg). |
@@ -1,22 +0,0 @@ | |||||
User Management | |||||
=============== | |||||
Banning | |||||
------- | |||||
To ban a user, invoke the Ban function on a Server object. | |||||
.. code-block:: c# | |||||
_server.Ban(_user, 30); | |||||
The pruneDays parameter, which defaults to 0, will remove all messages from a user dating back to the specified amount of days. | |||||
Kicking | |||||
------- | |||||
To kick a user, invoke the Kick function on the User. | |||||
.. code-block:: c# | |||||
_user.Kick(); |
@@ -1,13 +0,0 @@ | |||||
|stub| Voice | |||||
================= | |||||
|stub-desc| | |||||
Broadcasting | |||||
------------ | |||||
Multi-Server Broadcasting | |||||
------------------------- | |||||
Receiving | |||||
--------- |
@@ -1,48 +0,0 @@ | |||||
Getting Started | |||||
=============== | |||||
Requirements | |||||
------------ | |||||
Discord.Net currently requires logging in with a claimed account - anonymous logins are not supported. You can `register for a Discord account here`_. | |||||
New accounts are also useless when not connected to a server, so you should create an invite code for whatever server you intend to test on using the official Discord client. | |||||
.. _register for a Discord account here: https://discordapp.com/register | |||||
Installation | |||||
------------ | |||||
You can get Discord.Net from NuGet: | |||||
* `Discord.Net`_ | |||||
* `Discord.Net.Commands`_ | |||||
* `Discord.Net.Modules`_ | |||||
* `Discord.Net.Audio`_ | |||||
If you have trouble installing from NuGet, try installing dependencies manually. | |||||
You can also pull the latest source from `GitHub`_ | |||||
.. _Discord.Net: https://www.nuget.org/packages/Discord.Net | |||||
.. _Discord.Net.Commands: https://www.nuget.org/packages/Discord.Net.Commands | |||||
.. _Discord.Net.Modules: https://www.nuget.org/packages/Discord.Net.Modules | |||||
.. _Discord.Net.Modules: https://www.nuget.org/packages/Discord.Net.Audio | |||||
.. _GitHub: https://github.com/RogueException/Discord.Net/ | |||||
Async | |||||
----- | |||||
Discord.Net uses C# tasks extensively - nearly all operations return one. It is highly recommended that these tasks be awaited whenever possible. | |||||
To do so requires the calling method be marked as async, which can be problematic in a console application. An example of how to get around this is provided below. | |||||
For more information, go to `MSDN's Await-Async section`_. | |||||
.. _MSDN's Await-Async section: https://msdn.microsoft.com/en-us/library/hh191443.aspx | |||||
Example | |||||
------- | |||||
.. literalinclude:: samples/getting_started.cs | |||||
:language: csharp6 | |||||
:tab-width: 2 |
@@ -1,2 +0,0 @@ | |||||
.. |stub| unicode:: U+1F527 | |||||
.. |stub-desc| replace:: This page is a placeholder and has not been written yet. It should be coming soon! |
@@ -1,37 +0,0 @@ | |||||
Discord.Net | |||||
=========== | |||||
Discord.Net is an unofficial C# wrapper around the `Discord Chat Service`. | |||||
It offers several methods to create automated operations, bots, or even custom clients. | |||||
Feel free to join us in the `Discord API chat`_. | |||||
.. _Discord chat service: https://discordapp.com | |||||
.. _Discord API chat: https://discord.gg/0SBTUU1wZTVjAMPx | |||||
.. warn:: | |||||
This is a beta! | |||||
This library has been built thanks to a community effort reverse engineering the Discord client. | |||||
As the API is still unofficial, it may change at any time without notice, breaking this library as well. | |||||
Discord.Net itself is still in development (and is currently undergoing a rewrite) and you may encounter breaking changes throughout development until the official Discord API is released. | |||||
It is highly recommended that you always use the latest version and please report any bugs you find to our `Discord chat`_. | |||||
.. _Discord chat: https://discord.gg/0SBTUU1wZTVjAMPx | |||||
This Documentation is **currently undergoing a rewrite**. Some pages (marked with a wrench) are not updated, or are not completed yet. | |||||
.. toctree:: | |||||
:caption: Documentation | |||||
:maxdepth: 2 | |||||
getting_started | |||||
features/logging | |||||
features/server-management | |||||
features/user-management | |||||
features/permissions | |||||
features/commands | |||||
features/voice | |||||
features/events |
@@ -1,263 +0,0 @@ | |||||
@ECHO OFF | |||||
REM Command file for Sphinx documentation | |||||
if "%SPHINXBUILD%" == "" ( | |||||
set SPHINXBUILD=sphinx-build | |||||
) | |||||
set BUILDDIR=_build | |||||
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . | |||||
set I18NSPHINXOPTS=%SPHINXOPTS% . | |||||
if NOT "%PAPER%" == "" ( | |||||
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% | |||||
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% | |||||
) | |||||
if "%1" == "" goto help | |||||
if "%1" == "help" ( | |||||
:help | |||||
echo.Please use `make ^<target^>` where ^<target^> is one of | |||||
echo. html to make standalone HTML files | |||||
echo. dirhtml to make HTML files named index.html in directories | |||||
echo. singlehtml to make a single large HTML file | |||||
echo. pickle to make pickle files | |||||
echo. json to make JSON files | |||||
echo. htmlhelp to make HTML files and a HTML help project | |||||
echo. qthelp to make HTML files and a qthelp project | |||||
echo. devhelp to make HTML files and a Devhelp project | |||||
echo. epub to make an epub | |||||
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter | |||||
echo. text to make text files | |||||
echo. man to make manual pages | |||||
echo. texinfo to make Texinfo files | |||||
echo. gettext to make PO message catalogs | |||||
echo. changes to make an overview over all changed/added/deprecated items | |||||
echo. xml to make Docutils-native XML files | |||||
echo. pseudoxml to make pseudoxml-XML files for display purposes | |||||
echo. linkcheck to check all external links for integrity | |||||
echo. doctest to run all doctests embedded in the documentation if enabled | |||||
echo. coverage to run coverage check of the documentation if enabled | |||||
goto end | |||||
) | |||||
if "%1" == "clean" ( | |||||
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i | |||||
del /q /s %BUILDDIR%\* | |||||
goto end | |||||
) | |||||
REM Check if sphinx-build is available and fallback to Python version if any | |||||
%SPHINXBUILD% 2> nul | |||||
if errorlevel 9009 goto sphinx_python | |||||
goto sphinx_ok | |||||
:sphinx_python | |||||
set SPHINXBUILD=python -m sphinx.__init__ | |||||
%SPHINXBUILD% 2> nul | |||||
if errorlevel 9009 ( | |||||
echo. | |||||
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx | |||||
echo.installed, then set the SPHINXBUILD environment variable to point | |||||
echo.to the full path of the 'sphinx-build' executable. Alternatively you | |||||
echo.may add the Sphinx directory to PATH. | |||||
echo. | |||||
echo.If you don't have Sphinx installed, grab it from | |||||
echo.http://sphinx-doc.org/ | |||||
exit /b 1 | |||||
) | |||||
:sphinx_ok | |||||
if "%1" == "html" ( | |||||
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html | |||||
if errorlevel 1 exit /b 1 | |||||
echo. | |||||
echo.Build finished. The HTML pages are in %BUILDDIR%/html. | |||||
goto end | |||||
) | |||||
if "%1" == "dirhtml" ( | |||||
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml | |||||
if errorlevel 1 exit /b 1 | |||||
echo. | |||||
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. | |||||
goto end | |||||
) | |||||
if "%1" == "singlehtml" ( | |||||
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml | |||||
if errorlevel 1 exit /b 1 | |||||
echo. | |||||
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. | |||||
goto end | |||||
) | |||||
if "%1" == "pickle" ( | |||||
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle | |||||
if errorlevel 1 exit /b 1 | |||||
echo. | |||||
echo.Build finished; now you can process the pickle files. | |||||
goto end | |||||
) | |||||
if "%1" == "json" ( | |||||
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json | |||||
if errorlevel 1 exit /b 1 | |||||
echo. | |||||
echo.Build finished; now you can process the JSON files. | |||||
goto end | |||||
) | |||||
if "%1" == "htmlhelp" ( | |||||
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp | |||||
if errorlevel 1 exit /b 1 | |||||
echo. | |||||
echo.Build finished; now you can run HTML Help Workshop with the ^ | |||||
.hhp project file in %BUILDDIR%/htmlhelp. | |||||
goto end | |||||
) | |||||
if "%1" == "qthelp" ( | |||||
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp | |||||
if errorlevel 1 exit /b 1 | |||||
echo. | |||||
echo.Build finished; now you can run "qcollectiongenerator" with the ^ | |||||
.qhcp project file in %BUILDDIR%/qthelp, like this: | |||||
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\DiscordNet.qhcp | |||||
echo.To view the help file: | |||||
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\DiscordNet.ghc | |||||
goto end | |||||
) | |||||
if "%1" == "devhelp" ( | |||||
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp | |||||
if errorlevel 1 exit /b 1 | |||||
echo. | |||||
echo.Build finished. | |||||
goto end | |||||
) | |||||
if "%1" == "epub" ( | |||||
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub | |||||
if errorlevel 1 exit /b 1 | |||||
echo. | |||||
echo.Build finished. The epub file is in %BUILDDIR%/epub. | |||||
goto end | |||||
) | |||||
if "%1" == "latex" ( | |||||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex | |||||
if errorlevel 1 exit /b 1 | |||||
echo. | |||||
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. | |||||
goto end | |||||
) | |||||
if "%1" == "latexpdf" ( | |||||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex | |||||
cd %BUILDDIR%/latex | |||||
make all-pdf | |||||
cd %~dp0 | |||||
echo. | |||||
echo.Build finished; the PDF files are in %BUILDDIR%/latex. | |||||
goto end | |||||
) | |||||
if "%1" == "latexpdfja" ( | |||||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex | |||||
cd %BUILDDIR%/latex | |||||
make all-pdf-ja | |||||
cd %~dp0 | |||||
echo. | |||||
echo.Build finished; the PDF files are in %BUILDDIR%/latex. | |||||
goto end | |||||
) | |||||
if "%1" == "text" ( | |||||
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text | |||||
if errorlevel 1 exit /b 1 | |||||
echo. | |||||
echo.Build finished. The text files are in %BUILDDIR%/text. | |||||
goto end | |||||
) | |||||
if "%1" == "man" ( | |||||
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man | |||||
if errorlevel 1 exit /b 1 | |||||
echo. | |||||
echo.Build finished. The manual pages are in %BUILDDIR%/man. | |||||
goto end | |||||
) | |||||
if "%1" == "texinfo" ( | |||||
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo | |||||
if errorlevel 1 exit /b 1 | |||||
echo. | |||||
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. | |||||
goto end | |||||
) | |||||
if "%1" == "gettext" ( | |||||
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale | |||||
if errorlevel 1 exit /b 1 | |||||
echo. | |||||
echo.Build finished. The message catalogs are in %BUILDDIR%/locale. | |||||
goto end | |||||
) | |||||
if "%1" == "changes" ( | |||||
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes | |||||
if errorlevel 1 exit /b 1 | |||||
echo. | |||||
echo.The overview file is in %BUILDDIR%/changes. | |||||
goto end | |||||
) | |||||
if "%1" == "linkcheck" ( | |||||
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck | |||||
if errorlevel 1 exit /b 1 | |||||
echo. | |||||
echo.Link check complete; look for any errors in the above output ^ | |||||
or in %BUILDDIR%/linkcheck/output.txt. | |||||
goto end | |||||
) | |||||
if "%1" == "doctest" ( | |||||
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest | |||||
if errorlevel 1 exit /b 1 | |||||
echo. | |||||
echo.Testing of doctests in the sources finished, look at the ^ | |||||
results in %BUILDDIR%/doctest/output.txt. | |||||
goto end | |||||
) | |||||
if "%1" == "coverage" ( | |||||
%SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage | |||||
if errorlevel 1 exit /b 1 | |||||
echo. | |||||
echo.Testing of coverage in the sources finished, look at the ^ | |||||
results in %BUILDDIR%/coverage/python.txt. | |||||
goto end | |||||
) | |||||
if "%1" == "xml" ( | |||||
%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml | |||||
if errorlevel 1 exit /b 1 | |||||
echo. | |||||
echo.Build finished. The XML files are in %BUILDDIR%/xml. | |||||
goto end | |||||
) | |||||
if "%1" == "pseudoxml" ( | |||||
%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml | |||||
if errorlevel 1 exit /b 1 | |||||
echo. | |||||
echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. | |||||
goto end | |||||
) | |||||
:end |
@@ -1,10 +0,0 @@ | |||||
//Since we have setup our CommandChar to be '~', we will run this command by typing ~greet | |||||
commands.CreateCommand("greet") //create command greet | |||||
.Alias(new string[] { "gr", "hi" }) //add 2 aliases, so it can be run with ~gr and ~hi | |||||
.Description("Greets a person.") //add description, it will be shown when ~help is used | |||||
.Parameter("GreetedPerson", ParameterType.Required) //as an argument, we have a person we want to greet | |||||
.Do(async e => | |||||
{ | |||||
await client.SendMessage(e.Channel, e.User.Name + " greets " + e.GetArg("GreetedPerson")); | |||||
//sends a message to channel with the given text | |||||
}); |
@@ -1,21 +0,0 @@ | |||||
//we would run our commands with ~do greet X and ~do bye X | |||||
commands.CreateGroup("do", cgb => | |||||
{ | |||||
cgb.CreateCommand("greet") | |||||
.Alias(new string[] { "gr", "hi" }) | |||||
.Description("Greets a person.") | |||||
.Parameter("GreetedPerson", ParameterType.Required) | |||||
.Do(async e => | |||||
{ | |||||
await client.SendMessage(e.Channel, e.User.Name + " greets " + e.GetArg("GreetedPerson")); | |||||
}); | |||||
cgb.CreateCommand("bye") | |||||
.Alias(new string[] { "bb", "gb" }) | |||||
.Description("Greets a person.") | |||||
.Parameter("GreetedPerson", ParameterType.Required) | |||||
.Do(async e => | |||||
{ | |||||
await client.SendMessage(e.Channel, e.User.Name + " says goodbye to " + e.GetArg("GreetedPerson")); | |||||
}); | |||||
}); |
@@ -1,9 +0,0 @@ | |||||
//create command service | |||||
var commandService = new CommandService(new CommandServiceConfig | |||||
{ | |||||
CommandChar = '~', // prefix char for commands | |||||
HelpMode = HelpMode.Public | |||||
}); | |||||
//add command service | |||||
var commands = client.AddService(commandService); |
@@ -1,27 +0,0 @@ | |||||
class Program | |||||
{ | |||||
private static DiscordBotClient _client; | |||||
static void Main(string[] args) | |||||
{ | |||||
var client = new DiscordClient(); | |||||
// Handle Events using Lambdas | |||||
client.MessageCreated += (s, e) => | |||||
{ | |||||
if (!e.Message.IsAuthor) | |||||
await client.SendMessage(e.Message.ChannelId, "foo"); | |||||
} | |||||
// Handle Events using Event Handlers | |||||
EventHandler<MessageEventArgs> handler = new EventHandler<MessageEventArgs>(HandleMessageCreated); | |||||
client.MessageCreated += handler; | |||||
} | |||||
// NOTE: When using this method, 'client' must be accessible from outside the Main function. | |||||
static void HandleMessageCreated(object sender, EventArgs e) | |||||
{ | |||||
if (!e.Message.IsAuthor) | |||||
await client.SendMessage(e.Message.ChannelId, "foo"); | |||||
} | |||||
} |
@@ -1,28 +0,0 @@ | |||||
class Program | |||||
{ | |||||
static void Main(string[] args) | |||||
{ | |||||
var client = new DiscordClient(); | |||||
//Display all log messages in the console | |||||
client.LogMessage += (s, e) => Console.WriteLine($"[{e.Severity}] {e.Source}: {e.Message}"); | |||||
//Echo back any message received, provided it didn't come from the bot itself | |||||
client.MessageReceived += async (s, e) => | |||||
{ | |||||
if (!e.Message.IsAuthor) | |||||
await e.Channel.SendMessage(e.Message.Text); | |||||
}; | |||||
//Convert our sync method to an async one and block the Main function until the bot disconnects | |||||
client.ExecuteAndWait(async () => | |||||
{ | |||||
//Connect to the Discord server using our email and password | |||||
await client.Connect("discordtest@email.com", "Password123"); | |||||
//If we are not a member of any server, use our invite code (made beforehand in the official Discord Client) | |||||
if (!client.Servers.Any()) | |||||
await client.AcceptInvite(client.GetInvite("aaabbbcccdddeee")); | |||||
}); | |||||
} | |||||
} |
@@ -1,20 +0,0 @@ | |||||
class Program | |||||
{ | |||||
private static DiscordBotClient _client; | |||||
static void Main(string[] args) | |||||
{ | |||||
var client = new DiscordClient(x => | |||||
{ | |||||
LogLevel = LogSeverity.Info | |||||
}); | |||||
_client.Log.Message += (s, e) => Console.WriteLine($"[{e.Severity}] {e.Source}: {e.Message}"); | |||||
client.ExecuteAndWait(async () => | |||||
{ | |||||
await client.Connect("discordtest@email.com", "Password123"); | |||||
if (!client.Servers.Any()) | |||||
await client.AcceptInvite("aaabbbcccdddeee"); | |||||
}); | |||||
} | |||||
} |
@@ -1,14 +0,0 @@ | |||||
// Find a User's Channel Permissions | |||||
var userChannelPermissions = user.GetPermissions(channel); | |||||
// Find a User's Server Permissions | |||||
var userServerPermissions = user.ServerPermissions(); | |||||
var userServerPermissions = server.GetPermissions(user); | |||||
// Set a User's Channel Permissions (using DualChannelPermissions) | |||||
var userPerms = user.GetPermissions(channel); | |||||
userPerms.ReadMessageHistory = false; | |||||
userPerms.AttachFiles = null; | |||||
channel.AddPermissionsRule(user, userPerms); | |||||
} |