EliasSchriefer/LightDMMock
1
0
Fork 0
forked from SFS/LightDMMock
Code Issues Pull Requests Projects Releases Wiki Activity

Update readme

Browse Source 
...to my style
  ...for consistency
  ...to use ES6 modules (because I want my fork to be that)
This commit is contained in:
Elias Schriefer 2021-08-17 10:08:20 +02:00
parent 0fb379a2f5
commit 512bad6a36
1 changed files with 50 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

97
readme.md
View File

@ -1,75 +1,76 @@
# LightDMMock # LightDMMock
A LightDM Mock that is tightly based on the source [C code](https://github.com/Antergos/web-greeter/blob/before-python/src/webkit2-extension.c) of [Antergos](https://github.com/Antergos)' [lightdm-webkit2-greeter](https://github.com/Antergos/lightdm-webkit2-greeter). <font style="color:red">Please note that the deprecation errors are intrusive for a reason.</font> A LightDM Mock that is tightly based on the source [C code](https://github.com/Antergos/web-greeter/blob/before-python/src/webkit2-extension.c) of [Antergos](https://github.com/Antergos)' [lightdm-webkit2-greeter](https://github.com/Antergos/lightdm-webkit2-greeter). <font style="color:red">Please note that the deprecation errors are intrusive for a reason.</font>
## Usage: This is a rewrite in modern JavaScript.
[1]. Clone the repo
````bash
git clone git@github.com:CytoDev/LightDMMock.git
````
[2]. Include the file in your theme that needs mocking<br>
````html
<script type="text/javascript" src="mock/LightDMMock.js"></script>
````
[3]. Create a new instance of LightDMMock
````javascript
if(!("lightdm" in window)) {
var LightDMMock = LightDMMock || {};
window.lightdm = new LightDMMock(autofill, timeout, autoGuest);
}
````
## Note: ## Usage
1. Clone the repo
```bash
git clone https://git.sfs.ddnss.org/EliasSchriefer/LightDMMock
```
2. Set the type of your JavaScript to `module` in your theme that needs mocking
```html
<script type="module" src="main.js"></script>
```
```html
<script type="module">
...
</script>
```
3. Import `LightDMMock` and create a new instance
```javascript
import LightDMMock from "LightDMMock/src/LightDMMock.js";
window.lightdm = new LightDMMock(autofill, timeout, autoGuest);
```
## Note
If you plan on using the `.face` files in the mock you have to include the path to `LightDMMock/src`. The `.face` files linked in `users.json` are absolute links to `/home/[username]/.face`. If you plan on using the `.face` files in the mock you have to include the path to `LightDMMock/src`. The `.face` files linked in `users.json` are absolute links to `/home/[username]/.face`.
## Parameters of LightDMMock() ## Parameters of `LightDMMock()`
#### autofill > **autofill**: `boolean`
> **_`boolean`_**<br> >
> Wether or not the arrays for users, languages, layouts, and sessions need to be filled with mock data. I advise to test both to make your theme less prone to crashing. > Whether or not the arrays for users, languages, layouts, and sessions need to be filled with mock data. I advise to test both to make your theme less prone to crashing.
--- >
> **timeout**: `number`
#### timeout >
> **_`number`_**<br>
> Value to use for simulated autologin (this value is in seconds). > Value to use for simulated autologin (this value is in seconds).
--- >
> **autoGuest**: `boolean`
#### autoGuest >
> **_`boolean`_**<br> > Whether or not to simulate automatic guest login. This will also enable a guest account in `lightdm.has_guest_account`.
> Wether or not to simulate automatic guest login. This will also enable a guest account in `lightdm.has_guest_account`.
--- ---
### A friendly reminder ### A friendly reminder
The following functions __must__ be provided by the custom greeter, which LightDM will call in the process of authenticating the user. This can be found in the original documentation (man pages) of the webkit-greeter, but I have posted them here for your convenience. The following functions **must** be provided by the custom greeter, which LightDM will call in the process of authenticating the user. This can be found in the original documentation (man pages) of the webkit-greeter, but I have posted them here for your convenience.
> __show\_prompt(text, type)__<br> > **show_prompt(text, type)**
> ```` >
> This will be called when LightDM needs to prompt the user for some reason, such > This will be called when LightDM needs to prompt the user for some reason, such
> as asking for a password. The "text" parameter will be the text of the prompt, > as asking for a password. The "text" parameter will be the text of the prompt,
> and the "type" parameter will either be "text" for a visible prompt, or > and the "type" parameter will either be "text" for a visible prompt, or
> "password" for a prompt that the input should be hidden. > "password" for a prompt that the input should be hidden.
> ````
> >
> **show_message(text, type)**
> __show\_message(text, type)__<br> >
> ````
> This will be called when LightDM needs to display some info for the user. The > This will be called when LightDM needs to display some info for the user. The
> "text" parameter will be the text of the message, and the "type" parameter will > "text" parameter will be the text of the message, and the "type" parameter will
> either be "info" for an information message, or "error" for an error message > either be "info" for an information message, or "error" for an error message
> that LightDM has encountered. > that LightDM has encountered.
> ````
> >
> __authentication\_complete()__<br> > **authentication_complete()**
> ```` >
> This function is called by LightDM when authentication has completed. > This function is called by LightDM when authentication has completed.
> ````
> >
> __autologin\_timer\_expired()__<br> > **autologin_timer_expired()**
> ```` >
> This function is called by LightDM when an autologin user's login timer has > This function is called by LightDM when an autologin user's login timer has
> expired. The greeter should reset the authentication process. > expired. The greeter should reset the authentication process.
> ````
### License: ### License
This project is licensed under the MIT License. You can find a copy of the license [here](https://github.com/CytoDev/LightDMMock/license.md). This project is licensed under the MIT License. You can find a copy of the license [here](https://git.sfs.ddnss.org/EliasSchriefer/LightDMMock/license.md).
### Contributions: ### Contributions
You are more than welcome to submit issues as well as feature requests or just a 'how-ya-doin' in the [issue tracker](https://github.com/CytoDev/LightDMMock/issues/new). Contributing to the project can be done by forking it and submitting a pull request once it's all tested and tidy. You are more than welcome to submit issues as well as feature requests or just a 'how-ya-doin' in the [issue tracker](https://git.sfs.ddnss.org/EliasSchriefer/LightDMMock/issues/new). Contributing to the project can be done by forking it and submitting a pull request once it's all tested and tidy.